Merge pull request #25 from pypa/chrysle/src-layout

Migrate examples to `src-layout`
pypa · Apr 19, 2024 · 4f1c4b1 · 4f1c4b1
2 parents d6a93a1 + 8bfa373
commit 4f1c4b1
Show file tree

Hide file tree

Showing 22 changed files with 39 additions and 189 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+**/**/setup.py merge=ours
+**/**/pyproject.toml merge=ours
+table.md merge=ours
diff --git a/README.md b/README.md
@@ -44,8 +44,8 @@ However, developers might be interested in carrying out a *staggered migration*
 to mitigate the migration effort and spread the work load in time.
 
 Based on the results for the scenarios mixing `pkg_resources` and other namespace methods reported in
-[table.md](table.md) and [legacy_table.md](legacy_table.md),
-we can see that (in principle) a staggered migration plan can be successful,
+[table.md](table.md) and [legacy_table.md](https://github.com/pypa/sample-namespace-packages/blob/master/legacy_table.md)
+(only available for flat layout), we can see that (in principle) a staggered migration plan can be successful,
 as long as the developers are willing to accept some limitations:
 
 - Deprecated installation methods will not be supported (e.g. `python setup.py install`),
@@ -57,4 +57,4 @@ specific use cases they are interested in supporting.
 
 
 [^1]: If you would like to know about deprecated installation methods (e.g. via
-  `python setup.py install`) or Python 2.7, please have a look at [legacy_table.md](legacy_table.md).
+  `python setup.py install`) or Python 2.7 for the flat layout, please have a look at [legacy_table.md](https://github.com/pypa/sample-namespace-packages/blob/master/legacy_table.md).
diff --git a/legacy_table.md b/legacy_table.md
diff --git a/native/pkg_a/setup.py b/native/pkg_a/setup.py
@@ -27,7 +27,8 @@
     author_email='jonwayne@google.com',
 
     license='Apache Software License',
-
-    packages=['example_pkg.a'],
+    # This example uses automatic discovery. You can also implement custom discovery like this:
+    # packages=find_namespace_packages(where='src', include=['example_pkg.a']),
+    # package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/native/pkg_a/example_pkg/a/__init__.py → native/pkg_a/src/example_pkg/a/__init__.py b/native/pkg_a/example_pkg/a/__init__.py → native/pkg_a/src/example_pkg/a/__init__.py
diff --git a/native/pkg_b/setup.py b/native/pkg_b/setup.py
@@ -27,7 +27,8 @@
     author_email='jonwayne@google.com',
 
     license='Apache Software License',
-
-    packages=['example_pkg.b'],
+    # This example uses automatic discovery. You can also implement custom discovery like this:
+    # packages=find_namespace_packages(where='src', include=['example_pkg.b']),
+    # package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/native/pkg_b/example_pkg/b/__init__.py → native/pkg_b/src/example_pkg/b/__init__.py b/native/pkg_b/example_pkg/b/__init__.py → native/pkg_b/src/example_pkg/b/__init__.py
diff --git a/noxfile.py b/noxfile.py
@@ -25,18 +25,20 @@
     USE_PYTHON_VERSIONS = USE_PYTHON_VERSIONS_DEFAULT
 
 
-install_commands = (("pip", "install", "."), ("pip", "install", "-e", "."))
-
+install_commands = (
+    ('pip', 'install', '.'),
+    ('pip', 'install', '-e', '.')
+)
 
 def install_packages(session, package_a, package_b, command_a, command_b):
     env = {**os.environ, "PIP_CONSTRAINT": f"{HERE}/constraints.txt"}
     session.install("--upgrade", "pip", env=env)
     session.chdir(package_a)
-    session.run("rm", "-rf", "dist", "build", "*.egg-info")
+    session.run("rm", "-rf", "dist", "build", "*.egg-info", external=True)
     session.run(*command_a, env=env)
     session.chdir(HERE)
     session.chdir(package_b)
-    session.run("rm", "-rf", "dist", "build", "*.egg-info")
+    session.run("rm", "-rf", "dist", "build", "*.egg-info", external=True)
     session.run(*command_b, env=env)
     session.chdir(HERE)
 

diff --git a/pkg_resources/pkg_a/setup.py b/pkg_resources/pkg_a/setup.py
@@ -28,7 +28,8 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
     namespace_packages=['example_pkg'],
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkg_resources/pkg_a/example_pkg/__init__.py → ...sources/pkg_a/src/example_pkg/__init__.py b/pkg_resources/pkg_a/example_pkg/__init__.py → ...sources/pkg_a/src/example_pkg/__init__.py
diff --git a/...resources/pkg_a/example_pkg/a/__init__.py → ...urces/pkg_a/src/example_pkg/a/__init__.py b/...resources/pkg_a/example_pkg/a/__init__.py → ...urces/pkg_a/src/example_pkg/a/__init__.py
diff --git a/pkg_resources/pkg_b/setup.py b/pkg_resources/pkg_b/setup.py
@@ -28,7 +28,8 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
     namespace_packages=['example_pkg'],
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkg_resources/pkg_b/example_pkg/__init__.py → ...sources/pkg_b/src/example_pkg/__init__.py b/pkg_resources/pkg_b/example_pkg/__init__.py → ...sources/pkg_b/src/example_pkg/__init__.py
diff --git a/...resources/pkg_b/example_pkg/b/__init__.py → ...urces/pkg_b/src/example_pkg/b/__init__.py b/...resources/pkg_b/example_pkg/b/__init__.py → ...urces/pkg_b/src/example_pkg/b/__init__.py
diff --git a/pkgutil/pkg_a/setup.py b/pkgutil/pkg_a/setup.py
@@ -28,6 +28,7 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkgutil/pkg_a/example_pkg/__init__.py → pkgutil/pkg_a/src/example_pkg/__init__.py b/pkgutil/pkg_a/example_pkg/__init__.py → pkgutil/pkg_a/src/example_pkg/__init__.py
diff --git a/pkgutil/pkg_a/example_pkg/a/__init__.py → pkgutil/pkg_a/src/example_pkg/a/__init__.py b/pkgutil/pkg_a/example_pkg/a/__init__.py → pkgutil/pkg_a/src/example_pkg/a/__init__.py
diff --git a/pkgutil/pkg_b/setup.py b/pkgutil/pkg_b/setup.py
@@ -28,6 +28,7 @@
 
     license='Apache Software License',
 
-    packages=find_packages(),
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
     zip_safe=False,
 )
diff --git a/pkgutil/pkg_b/example_pkg/__init__.py → pkgutil/pkg_b/src/example_pkg/__init__.py b/pkgutil/pkg_b/example_pkg/__init__.py → pkgutil/pkg_b/src/example_pkg/__init__.py
diff --git a/pkgutil/pkg_b/example_pkg/b/__init__.py → pkgutil/pkg_b/src/example_pkg/b/__init__.py b/pkgutil/pkg_b/example_pkg/b/__init__.py → pkgutil/pkg_b/src/example_pkg/b/__init__.py
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
 # -- PYTHON PACKAGE REQUIREMENTS:
 # USE: pip install -r <THIS_FILE>
 
+setuptools >= 68.2.2
 nox >= 2023.04.22