ansys / ansys/pyansys-tools-variableinterop

Cleanup: make import style consistent across project

Open
#50 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Currently we use several different import styles across the project. For consistency we should agree on one and use it whenever possible. Apparently it is safe to use `from module import something`, *as long as you go to the lowest level module possible*, so I propose using that since the code looks cleaner.

```python
import ansys.common.variableinterop.real_value as real_value # good
import ansys.common.variableinterop as acvi # bad (but safe for tests/client use)

from .real_value import RealValue # good
from . import RealValue # bad
```

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the Python import statements across the project and review the examples in the issue. Determine whether a single lowest-level import style is appropriate for production code, tests, and client use; done means the project follows an agreed convention consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.