ci: update files according to other projects

Author: karlicoss

conftest.py

@@ -20,6 +20,8 @@
 # resolve_package_path is called from _pytest.pathlib.import_path
 # takes a full abs path to the test file and needs to return the path to the 'root' package on the filesystem
 resolve_pkg_path_orig = _pytest.pathlib.resolve_package_path
+
+
 def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
     result = path  # search from the test file upwards
     for parent in result.parents:
@@ -30,6 +32,8 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
         if path.name == 'conftest.py':
             return resolve_pkg_path_orig(path)
     raise RuntimeError("Couldn't determine path for ", path)
+
+
 _pytest.pathlib.resolve_package_path = resolve_package_path
 
 
@@ -38,10 +42,14 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
 # so we need to point it at the absolute path properly
 # not sure what are the consequences.. maybe it wouldn't be able to run against installed packages? not sure..
 search_pypath_orig = _pytest.main.search_pypath
+
+
 def search_pypath(module_name: str) -> str:
     mpath = root_dir / module_name.replace('.', os.sep)
     if not mpath.is_dir():
         mpath = mpath.with_suffix('.py')
         assert mpath.exists(), mpath  # just in case
     return str(mpath)
+
+
 _pytest.main.search_pypath = search_pypath

old/setup.py

@@ -1,56 +1,47 @@
 # see https://github.com/karlicoss/pymplate for up-to-date reference
 
 
-from setuptools import setup, find_namespace_packages # type: ignore
+from setuptools import setup, find_namespace_packages  # type: ignore
 
 
 def main() -> None:
     # works with both ordinary and namespace packages
     pkgs = find_namespace_packages('src')
-    pkg = min(pkgs) # lexicographically smallest is the correct one usually?
+    pkg = min(pkgs)  # lexicographically smallest is the correct one usually?
     setup(
         name=pkg,
         use_scm_version={
             'version_scheme': 'python-simplified-semver',
             'local_scheme': 'dirty-tag',
         },
         setup_requires=['setuptools_scm'],
-
         # otherwise mypy won't work
         # https://mypy.readthedocs.io/en/stable/installed_packages.html#making-pep-561-compatible-packages
         zip_safe=False,
-
         packages=pkgs,
         package_dir={'': 'src'},
         # necessary so that package works with mypy
         package_data={pkg: ['py.typed']},
-
         ## ^^^ this should be mostly automatic and not requiring any changes
-
         install_requires=[
             # vvv example of git repo dependency
             # 'repo @ git+https://github.com/karlicoss/repo.git',
-
             # vvv  example of local file dependency. yes, DUMMY is necessary for some reason
             # 'repo @ git+file://DUMMY/path/to/repo',
         ],
         extras_require={
             'testing': ['pytest'],
-            'linting': ['pytest', 'ruff', 'mypy', 'lxml'], # lxml for mypy coverage report
+            'linting': ['pytest', 'ruff', 'mypy', 'lxml'],  # lxml for mypy coverage report
         },
-
-
         # this needs to be set if you're planning to upload to pypi
         # url='',
         # author='',
         # author_email='',
         # description='',
-
         # Rest of the stuff -- classifiers, license, etc, I don't think it matters for pypi
         # it's just unnecessary duplication
     )
 
 
 if __name__ == '__main__':
     main()
-

pyproject.toml

@@ -1,6 +1,6 @@
 # see https://github.com/karlicoss/pymplate for up-to-date reference
 [project]
-dynamic = ["version"]  # version is managed by setuptools_scm
+dynamic = ["version"]  # version is managed by build backend
 name = "karlicoss_pymplate"
 dependencies = [
 ]

pytest.ini

@@ -1,6 +1,10 @@
 [pytest]
 # discover files that don't follow test_ naming. Useful to keep tests along with the source code
 python_files = *.py
+
+# this setting only impacts package/module naming under pytest, not the discovery
+consider_namespace_packages = true
+
 addopts =
   # prevent pytest cache from being created... it craps into project dir and I never use it anyway
   -p no:cacheprovider

ruff.toml

@@ -137,6 +137,10 @@ lint.ignore = [
     "SIM",     # some if statements crap
     "RSE102",  # complains about missing parens in exceptions
     ##
+]
+
 
-    "RUF001",  # complains about unicode.. but we're legit using it in tests
+lint.exclude = [
+    "old/**",
+    "tests/testdata/**",
 ]

src/karlicoss_pymplate/module.py

@@ -7,6 +7,7 @@
 
 
 def test_module_name() -> None:
+    assert __package__ == 'karlicoss_pymplate'
     # just in case because pytest might have some shenanigans with test module names depending on args..
     assert __name__ == 'karlicoss_pymplate.module'
 

src/karlicoss_pymplate/subpackage/submodule.py

@@ -4,13 +4,14 @@ def test() -> None:
 
     # check names because pytest might mess this up (also see conftest.py for some hacks)
     assert __package__ == 'karlicoss_pymplate.subpackage'
-    assert __name__    == 'karlicoss_pymplate.subpackage.submodule'
+    assert __name__ == 'karlicoss_pymplate.subpackage.submodule'
 
 
 ## just check that mypy works
 class A:
     pass
 
+
 import typing
 
 if typing.TYPE_CHECKING:

tests/test_pytest.py

@@ -1,27 +1,30 @@
 #!/usr/bin/env python3
 from __future__ import annotations
+
 # not using pytest here to avoid interference from actual pytest
 import contextlib
 import os
-from pathlib import Path
 import re
+import shlex
 import shutil
-import sys
 import subprocess
+import sys
+from collections.abc import Iterator
+from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Iterator
 
 THISDIR = Path(__file__).absolute().parent
 GIT_ROOT = THISDIR.parent
 
+
 # only available since python 3.11
 class contextlib_chdir(contextlib.AbstractContextManager):
     def __init__(self, path):
         self.path = path
         self._old_cwd = []
 
     def __enter__(self):
-        self._old_cwd.append(os.getcwd())
+        self._old_cwd.append(Path.cwd())
         os.chdir(self.path)
 
     def __exit__(self, *excinfo):
@@ -32,21 +35,25 @@ def __exit__(self, *excinfo):
 def fixture() -> Iterator[Path]:
     with TemporaryDirectory() as td:
         root = Path(td)
-        shutil.copy(GIT_ROOT / 'pytest.ini' , root / 'pytest.ini')
+        shutil.copy(GIT_ROOT / 'pytest.ini', root / 'pytest.ini')
         shutil.copy(GIT_ROOT / 'conftest.py', root / 'conftest.py')
+        # TODO overwrite consider namesspace pkgs here for now??
         shutil.copytree(THISDIR / 'testdata' / 'src', root / 'src')
         with contextlib_chdir(root):
             yield root
 
+
 def run(package: str) -> list[str]:
     # returns the tests that ran
-    output = subprocess.check_output([sys.executable, '-m', 'pytest', '--pyargs', package, '-s'], text=True, stderr=subprocess.STDOUT)
+    cmd = [sys.executable, '-m', 'pytest', '--pyargs', package, '-s']
+    print('pytest command: ', shlex.join(cmd), file=sys.stderr)
+    output = subprocess.check_output(cmd, text=True, stderr=subprocess.STDOUT, env={'PYTHONPATH': 'src', **os.environ})
     return sorted(re.findall(r'RUNNING ([\w.]+)', output))
 
 
 def test_basic() -> None:
     # should collect/run all tests
-    with fixture() as root:
+    with fixture() as _root:
         res = run('mypkg')
         assert res == [
             'doctest',
@@ -59,7 +66,7 @@ def test_basic() -> None:
 
 
 def test_subpackage_1() -> None:
-    with fixture() as root:
+    with fixture() as _root:
         res = run('mypkg.a')
         assert res == [
             'mypkg.a.aa.main',
@@ -68,15 +75,15 @@ def test_subpackage_1() -> None:
 
 
 def test_subpackage_2() -> None:
-    with fixture() as root:
+    with fixture() as _root:
         res = run('mypkg.a.aa')
         assert res == [
             'mypkg.a.aa.main',
         ], res
 
 
 def test_module_1() -> None:
-    with fixture() as root:
+    with fixture() as _root:
         res = run('mypkg.main')
         assert res == [
             'doctest',
@@ -86,7 +93,7 @@ def test_module_1() -> None:
 
 def test_module_2() -> None:
     # checks that it works with __init__.py
-    with fixture() as root:
+    with fixture() as _root:
         res = run('mypkg.c')
         assert res == [
             'mypkg.c',
@@ -105,5 +112,6 @@ def main() -> None:
         print("RUNNING", test)
         test()
 
+
 if __name__ == '__main__':
     main()

tests/testdata/src/mypkg/a/aa/main.py

@@ -1,4 +1,5 @@
 from ...b import for_aa
 
+
 def test():
     print("RUNNING", __name__)

tox.ini

@@ -26,7 +26,7 @@ package = uv-editable
 skip_install = true
 dependency_groups = testing
 commands =
-    {envpython} -m ruff check src/ \
+    {envpython} -m ruff check \
         {posargs}