OpenwaterHealth/openlifu-python

use absolute rather than relative imports

Open

#13 opened on Jun 17, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (16 forks)auto 404
good first issue

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

This is a style suggestion and we may decide to close it if absolute imports are too unwieldy and verbose.

See https://peps.python.org/pep-0008/#imports :

Absolute imports are recommended, as they are usually more readable and tend to be better behaved (or at least give better error messages) if the import system is incorrectly configured (such as when a directory inside a package ends up on sys.path) ... ... However, explicit relative imports are an acceptable alternative to absolute imports, especially when dealing with complex package layouts where using absolute imports would be unnecessarily verbose

Contributor guide

Research direction
Identify all relative imports in the codebase and convert them to absolute imports following PEP 8 guidelines. Start by examining the project's package structure and then update each import statement.
Tech stack
python
Domain
backend
Issue type
Refactor
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65