Repository navigation
Commit b981ce7
committed
chore: rename gitlab/__version__.py -> gitlab/_version.py
It is confusing to have a `gitlab/__version__.py` because we also
create a variable `gitlab.__version__` which can conflict with
`gitlab/__version__.py`.
For example in `gitlab/const.py` we have to know that
`gitlab.__version__` is a module and not the variable due to the
ordering of imports. But in most other usage `gitlab.__version__` is a
version string.
To reduce confusion make the name of the version file
`gitlab/_version.py`.1 parent cbbe7ce commit b981ce7
7 files changed
Lines changed: 6 additions & 6 deletions
File tree
- gitlab
- tests/smoke
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -153,7 +153,7 @@ This avoids triggering incorrect version bumps and releases without functional c | |||
| 153 | 153 | The release workflow uses `python-semantic-release | |
| 154 | 154 | <https://python-semantic-release.readthedocs.io>`_ and does the following: | |
| 155 | 155 | ||
| 156 | - * Bumps the version in ``__version__.py`` and adds an entry in ``CHANGELOG.md``, | ||
| 156 | + * Bumps the version in ``_version.py`` and adds an entry in ``CHANGELOG.md``, | ||
| 157 | 157 | * Commits and tags the changes, then pushes to the main branch as the ``github-actions`` user, | |
| 158 | 158 | * Creates a release from the tag and adds the changelog entry to the release notes, | |
| 159 | 159 | * Uploads the package as assets to the GitHub release, | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -20,7 +20,7 @@ | |||
| 20 | 20 | from typing import Any | |
| 21 | 21 | ||
| 22 | 22 | import gitlab.config # noqa: F401 | |
| 23 | - from gitlab.__version__ import ( # noqa: F401 | ||
| 23 | + from gitlab._version import ( # noqa: F401 | ||
| 24 | 24 | __author__, | |
| 25 | 25 | __copyright__, | |
| 26 | 26 | __email__, | |
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -15,7 +15,7 @@ | |||
| 15 | 15 | # You should have received a copy of the GNU Lesser General Public License | |
| 16 | 16 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 | 17 | ||
| 18 | - from gitlab.__version__ import __title__, __version__ | ||
| 18 | + from gitlab._version import __title__, __version__ | ||
| 19 | 19 | ||
| 20 | 20 | # NOTE(jlvillal): '_DEPRECATED' only affects users accessing constants via the | |
| 21 | 21 | # top-level gitlab.* namespace. See 'gitlab/__init__.py:__getattr__()' for the | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -38,7 +38,7 @@ ignore_errors = true | |||
| 38 | 38 | ||
| 39 | 39 | [tool.semantic_release] | |
| 40 | 40 | branch = "main" | |
| 41 | - version_variable = "gitlab/__version__.py:__version__" | ||
| 41 | + version_variable = "gitlab/_version.py:__version__" | ||
| 42 | 42 | commit_subject = "chore: release v{version}" | |
| 43 | 43 | commit_message = "" | |
| 44 | 44 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,7 +6,7 @@ | |||
| 6 | 6 | ||
| 7 | 7 | def get_version() -> str: | |
| 8 | 8 | version = "" | |
| 9 | - with open("gitlab/__version__.py") as f: | ||
| 9 | + with open("gitlab/_version.py") as f: | ||
| 10 | 10 | for line in f: | |
| 11 | 11 | if line.startswith("__version__"): | |
| 12 | 12 | version = eval(line.split("=")[-1]) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,7 +6,7 @@ | |||
| 6 | 6 | import pytest | |
| 7 | 7 | from setuptools import sandbox | |
| 8 | 8 | ||
| 9 | - from gitlab import __title__, __version__ | ||
| 9 | + from gitlab._version import __title__, __version__ | ||
| 10 | 10 | ||
| 11 | 11 | DIST_DIR = Path("dist") | |
| 12 | 12 | DOCS_DIR = "docs" | |
0 commit comments