lordmauve/pgzero

Add __dir__() to built-in objects

Open

#101 opened on Jul 29, 2018

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

Description

The REPL added in #80 has built-in autocompletion:

autocompletion

However various built-in objects do not take full advantage of this:

  • Actor does not have autocompletion for attributes delegated to the ZRect
  • Loaders do not have autocompletion for the objects that can be loaded
  • more?

We should implement __dir__() on these classes and others to ensure that autocompletion lists all valid attributes.

Contributor guide

Tech stack
python
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsUnderstanding dir pgzero codebase basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the Actor class to identify attributes delegated to ZRect. Explore the loader module to list objects that can be loaded. Look for other built in objects that might benefit from dir implementation. Check if any existing dir methods are present in the codebase.