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`.

CONTRIBUTING.rst

@@ -153,7 +153,7 @@ This avoids triggering incorrect version bumps and releases without functional c
 The release workflow uses `python-semantic-release
 <https://python-semantic-release.readthedocs.io>`_ and does the following:
 
-* Bumps the version in ``__version__.py`` and adds an entry in ``CHANGELOG.md``,
+* Bumps the version in ``_version.py`` and adds an entry in ``CHANGELOG.md``,
 * Commits and tags the changes, then pushes to the main branch as the ``github-actions`` user,
 * Creates a release from the tag and adds the changelog entry to the release notes,
 * Uploads the package as assets to the GitHub release,

gitlab/__init__.py

@@ -20,7 +20,7 @@
 from typing import Any
 
 import gitlab.config  # noqa: F401
-from gitlab.__version__ import (  # noqa: F401
+from gitlab._version import (  # noqa: F401
     __author__,
     __copyright__,
     __email__,

gitlab/const.py

@@ -15,7 +15,7 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from gitlab.__version__ import __title__, __version__
+from gitlab._version import __title__, __version__
 
 # NOTE(jlvillal): '_DEPRECATED' only affects users accessing constants via the
 # top-level gitlab.* namespace. See 'gitlab/__init__.py:__getattr__()' for the

pyproject.toml

@@ -38,7 +38,7 @@ ignore_errors = true
 
 [tool.semantic_release]
 branch = "main"
-version_variable = "gitlab/__version__.py:__version__"
+version_variable = "gitlab/_version.py:__version__"
 commit_subject = "chore: release v{version}"
 commit_message = ""
 

setup.py

@@ -6,7 +6,7 @@
 
 def get_version() -> str:
     version = ""
-    with open("gitlab/__version__.py") as f:
+    with open("gitlab/_version.py") as f:
         for line in f:
             if line.startswith("__version__"):
                 version = eval(line.split("=")[-1])

tests/smoke/test_dists.py

@@ -6,7 +6,7 @@
 import pytest
 from setuptools import sandbox
 
-from gitlab import __title__, __version__
+from gitlab._version import __title__, __version__
 
 DIST_DIR = Path("dist")
 DOCS_DIR = "docs"