lordmauve/pgzero

Expose Clock instance directly in order to get the current game time

Open

#357 opened on Apr 14, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (472 stars) (185 forks)batch import
enhancementgood first issue

Description

Clock.t stores the elapsed time of the clock.

Due to the way we expose the clock in builtins, clock is a module. We could convert it to a Clock instance, in which case clock.t would be a way of accessing the time.

(We should explain in documentation that t is the commonly used mathematical variable for time, hence the short name.)

Contributor guide

Tech stack
python
Domain
apidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue proposes converting the clock module into a Clock instance so that `clock.t` directly provides the elapsed time. First, examine how `clock` is currently exported as a module in the builtins. Then, implement the change to make `clock` an instance of a Clock class, ensuring backward compatibility. After the code change, update the documentation to explain the new access pattern and the meaning of `t`. Look for any existing tests related to clock in the test directory and ensure they pass.