pre-commit

RonnyPfannschmidt · RonnyPfannschmidt · commit 08613d7197f9 · 2021-02-01T09:40:27.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ python:
 env:
   - EDITABLE=-e
   - EDITABLE=
-install: 
+install:
 - pip install -U setuptools pip setuptools_scm pytest
 - pip install $EDITABLE .
 # command to run tests
diff --git a/CHANGELOG b/CHANGELOG
@@ -73,4 +73,3 @@
 
 - added special __onfirstaccess__ attribute whose value will
   be called on the first attribute access of an apimodule.
-
diff --git a/LICENSE b/LICENSE
@@ -5,15 +5,14 @@
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
-     
+
   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.
- 
+
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
-
diff --git a/conftest.py b/conftest.py
@@ -1,9 +1,12 @@
 import py
+
 import apipkg
-LOCAL_APIPKG = py.path.local(__file__).dirpath().join('src/apipkg/__init__.py')
-INSTALL_TYPE = 'editable' if apipkg.__file__ == LOCAL_APIPKG else 'full'
+
+LOCAL_APIPKG = py.path.local(__file__).dirpath().join("src/apipkg/__init__.py")
+INSTALL_TYPE = "editable" if apipkg.__file__ == LOCAL_APIPKG else "full"
 
 
 def pytest_report_header(startdir):
     return "apipkg {install_type} install version={version}".format(
-        install_type=INSTALL_TYPE, version=apipkg.__version__)
+        install_type=INSTALL_TYPE, version=apipkg.__version__
+    )
diff --git a/example/_mypkg/othermodule.py b/example/_mypkg/othermodule.py
@@ -1,3 +1,2 @@
-
 class OtherClass:
     pass
diff --git a/example/_mypkg/somemodule.py b/example/_mypkg/somemodule.py
@@ -1,5 +1,5 @@
+from _mypkg.othermodule import OtherClass  # NOQA: F401
 
-from _mypkg.othermodule import OtherClass
 
 class SomeClass:
     pass
diff --git a/example/mypkg/__init__.py b/example/mypkg/__init__.py
@@ -1,9 +1,12 @@
 # mypkg/__init__.py
-
 import apipkg
-apipkg.initpkg(__name__, {
-    'SomeClass': '_mypkg.somemodule:SomeClass',
-    'sub': {
-        'OtherClass': '_mypkg.somemodule:OtherClass',
-    }
-})
+
+apipkg.initpkg(
+    __name__,
+    {
+        "SomeClass": "_mypkg.somemodule:SomeClass",
+        "sub": {
+            "OtherClass": "_mypkg.somemodule:OtherClass",
+        },
+    },
+)
diff --git a/example/mypkg/othermodule.py b/example/mypkg/othermodule.py
@@ -1,3 +1,2 @@
-
 class OtherClass:
     pass
diff --git a/example/mypkg/somemodule.py b/example/mypkg/somemodule.py
@@ -1,5 +1,5 @@
+from __mypkg.othermodule import OtherClass  # NOQA: F401
 
-from __mypkg.othermodule import OtherClass
 
 class SomeClass:
     pass
diff --git a/setup.cfg b/setup.cfg
@@ -1,2 +1,50 @@
+[metadata]
+name = apipkg
+description = apipkg: namespace control and lazy-import mechanism
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+url = https://github.com/pytest-dev/apipkg
+author = holger krekel
+maintainer = Ronny Pfannschmidt
+maintainer_email = opensource@ronnypfannschmidt.de
+license = MIT
+license_file = LICENSE
+platforms =
+    unix
+    linux
+    osx
+    cygwin
+    win32
+classifiers =
+    Development Status :: 4 - Beta
+    Intended Audience :: Developers
+    License :: OSI Approved :: MIT License
+    Operating System :: MacOS :: MacOS X
+    Operating System :: Microsoft :: Windows
+    Operating System :: POSIX
+    Programming Language :: Python
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 2.7
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.4
+    Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: Implementation :: CPython
+    Topic :: Software Development :: Libraries
+
+[options]
+packages = find:
+python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
+package_dir = =src
+setup_requires =
+    setuptools>=30.3.0
+    setuptools_scm
+
+[options.packages.find]
+where = src
+
 [wheel]
-universal=true
+universal = true
diff --git a/setup.py b/setup.py
@@ -1,53 +1,5 @@
-from setuptools import setup, find_packages
+from setuptools import setup
 
-
-def readme():
-    with open('README.rst') as fp:
-        return fp.read()
-
-
-def main():
-    setup(
-        name='apipkg',
-        description='apipkg: namespace control and lazy-import mechanism',
-        long_description=readme(),
-        python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*',
-        setup_requires=[
-            'setuptools_scm',
-            'setuptools>=30.3.0',  # introduced setup.cfg metadata
-        ],
-        use_scm_version={
-            'write_to': 'src/apipkg/version.py'
-        },
-        url='https://github.com/pytest-dev/apipkg',
-        license='MIT License',
-        platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'],
-        author='holger krekel',
-        maintainer="Ronny Pfannschmidt",
-        maintainer_email="opensource@ronnypfannschmidt.de",
-        classifiers=[
-            'Development Status :: 4 - Beta',
-            'Intended Audience :: Developers',
-            'License :: OSI Approved :: MIT License',
-            'Operating System :: POSIX',
-            'Operating System :: Microsoft :: Windows',
-            'Operating System :: MacOS :: MacOS X',
-            'Topic :: Software Development :: Libraries',
-            # Specify the Python versions you support here.
-            # In particular,  ensure that you indicate whether
-            # you support Python 2, Python 3 or both.
-            'Programming Language :: Python',
-            'Programming Language :: Python :: 2',
-            'Programming Language :: Python :: 2.7',
-            'Programming Language :: Python :: 3',
-            'Programming Language :: Python :: 3.4',
-            'Programming Language :: Python :: 3.5',
-            'Programming Language :: Python :: 3.6',
-        ],
-        packages=find_packages('src'),
-        package_dir={'': 'src'},
-    )
-
-
-if __name__ == '__main__':
-    main()
+setup(
+    use_scm_version={"write_to": "src/apipkg/version.py"},
+)
diff --git a/src/apipkg/__init__.py b/src/apipkg/__init__.py
@@ -9,15 +9,15 @@
 import sys
 from types import ModuleType
 
-from .version import version as __version__
+from .version import version as __version__  # NOQA:F401
 
 
 def _py_abspath(path):
     """
     special version of abspath
     that will leave paths from jython jars alone
     """
-    if path.startswith('__pyclasspath__'):
+    if path.startswith("__pyclasspath__"):
 
         return path
     else:
@@ -28,6 +28,7 @@ def distribution_version(name):
     """try to get the version of the named distribution,
     returs None on failure"""
     from pkg_resources import get_distribution, DistributionNotFound
+
     try:
         dist = get_distribution(name)
     except DistributionNotFound:
@@ -41,35 +42,35 @@ def initpkg(pkgname, exportdefs, attr=None, eager=False):
     attr = attr or {}
     oldmod = sys.modules.get(pkgname)
     d = {}
-    f = getattr(oldmod, '__file__', None)
+    f = getattr(oldmod, "__file__", None)
     if f:
         f = _py_abspath(f)
-    d['__file__'] = f
-    if hasattr(oldmod, '__version__'):
-        d['__version__'] = oldmod.__version__
-    if hasattr(oldmod, '__loader__'):
-        d['__loader__'] = oldmod.__loader__
-    if hasattr(oldmod, '__path__'):
-        d['__path__'] = [_py_abspath(p) for p in oldmod.__path__]
-    if hasattr(oldmod, '__package__'):
-        d['__package__'] = oldmod.__package__
-    if '__doc__' not in exportdefs and getattr(oldmod, '__doc__', None):
-        d['__doc__'] = oldmod.__doc__
+    d["__file__"] = f
+    if hasattr(oldmod, "__version__"):
+        d["__version__"] = oldmod.__version__
+    if hasattr(oldmod, "__loader__"):
+        d["__loader__"] = oldmod.__loader__
+    if hasattr(oldmod, "__path__"):
+        d["__path__"] = [_py_abspath(p) for p in oldmod.__path__]
+    if hasattr(oldmod, "__package__"):
+        d["__package__"] = oldmod.__package__
+    if "__doc__" not in exportdefs and getattr(oldmod, "__doc__", None):
+        d["__doc__"] = oldmod.__doc__
     d.update(attr)
     if hasattr(oldmod, "__dict__"):
         oldmod.__dict__.update(d)
     mod = ApiModule(pkgname, exportdefs, implprefix=pkgname, attr=d)
     sys.modules[pkgname] = mod
     # eagerload in bypthon to avoid their monkeypatching breaking packages
-    if 'bpython' in sys.modules or eager:
+    if "bpython" in sys.modules or eager:
         for module in list(sys.modules.values()):
             if isinstance(module, ApiModule):
                 module.__dict__
 
 
 def importobj(modpath, attrname):
     """imports a module, then resolves the attrname on it"""
-    module = __import__(modpath, None, None, ['__doc__'])
+    module = __import__(modpath, None, None, ["__doc__"])
     if not attrname:
         return module
 
@@ -82,20 +83,22 @@ def importobj(modpath, attrname):
 
 class ApiModule(ModuleType):
     """the magical lazy-loading module standing"""
+
     def __docget(self):
         try:
             return self.__doc
         except AttributeError:
-            if '__doc__' in self.__map__:
-                return self.__makeattr('__doc__')
+            if "__doc__" in self.__map__:
+                return self.__makeattr("__doc__")
 
     def __docset(self, value):
         self.__doc = value
+
     __doc__ = property(__docget, __docset)
 
     def __init__(self, name, importspec, implprefix=None, attr=None):
         self.__name__ = name
-        self.__all__ = [x for x in importspec if x != '__onfirstaccess__']
+        self.__all__ = [x for x in importspec if x != "__onfirstaccess__"]
         self.__map__ = {}
         self.__implprefix__ = implprefix or name
         if attr:
@@ -104,47 +107,47 @@ def __init__(self, name, importspec, implprefix=None, attr=None):
                 setattr(self, name, val)
         for name, importspec in importspec.items():
             if isinstance(importspec, dict):
-                subname = '%s.%s' % (self.__name__, name)
+                subname = "{}.{}".format(self.__name__, name)
                 apimod = ApiModule(subname, importspec, implprefix)
                 sys.modules[subname] = apimod
                 setattr(self, name, apimod)
             else:
-                parts = importspec.split(':')
+                parts = importspec.split(":")
                 modpath = parts.pop(0)
                 attrname = parts and parts[0] or ""
-                if modpath[0] == '.':
+                if modpath[0] == ".":
                     modpath = implprefix + modpath
 
                 if not attrname:
-                    subname = '%s.%s' % (self.__name__, name)
+                    subname = "{}.{}".format(self.__name__, name)
                     apimod = AliasModule(subname, modpath)
                     sys.modules[subname] = apimod
-                    if '.' not in name:
+                    if "." not in name:
                         setattr(self, name, apimod)
                 else:
                     self.__map__[name] = (modpath, attrname)
 
     def __repr__(self):
         repr_list = []
-        if hasattr(self, '__version__'):
+        if hasattr(self, "__version__"):
             repr_list.append("version=" + repr(self.__version__))
-        if hasattr(self, '__file__'):
-            repr_list.append('from ' + repr(self.__file__))
+        if hasattr(self, "__file__"):
+            repr_list.append("from " + repr(self.__file__))
         if repr_list:
-            return '<ApiModule %r %s>' % (self.__name__, " ".join(repr_list))
-        return '<ApiModule %r>' % (self.__name__,)
+            return "<ApiModule {!r} {}>".format(self.__name__, " ".join(repr_list))
+        return "<ApiModule {!r}>".format(self.__name__)
 
     def __makeattr(self, name):
         """lazily compute value for name or raise AttributeError if unknown."""
         # print "makeattr", self.__name__, name
         target = None
-        if '__onfirstaccess__' in self.__map__:
-            target = self.__map__.pop('__onfirstaccess__')
+        if "__onfirstaccess__" in self.__map__:
+            target = self.__map__.pop("__onfirstaccess__")
             importobj(*target)()
         try:
             modpath, attrname = self.__map__[name]
         except KeyError:
-            if target is not None and name != '__onfirstaccess__':
+            if target is not None and name != "__onfirstaccess__":
                 # retry, onfirstaccess might have set attrs
                 return getattr(self, name)
             raise AttributeError(name)
@@ -163,10 +166,10 @@ def __makeattr(self, name):
     def __dict__(self):
         # force all the content of the module
         # to be loaded when __dict__ is read
-        dictdescr = ModuleType.__dict__['__dict__']
+        dictdescr = ModuleType.__dict__["__dict__"]
         dict = dictdescr.__get__(self)
         if dict is not None:
-            hasattr(self, 'some')
+            hasattr(self, "some")
             for name in self.__all__:
                 try:
                     self.__makeattr(name)
@@ -187,12 +190,11 @@ def getmod():
         return mod[0]
 
     class AliasModule(ModuleType):
-
         def __repr__(self):
             x = modpath
             if attrname:
                 x += "." + attrname
-            return '<AliasModule %r for %r>' % (modname, x)
+            return "<AliasModule {!r} for {!r}>".format(modname, x)
 
         def __getattribute__(self, name):
             try:
diff --git a/test_apipkg.py b/test_apipkg.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -73,4 +73,3 @@`
`73`	`73`
`74`	`74`	`- added special __onfirstaccess__ attribute whose value will`
`75`	`75`	`be called on the first attribute access of an apimodule.`
`76`		`-`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`		`-`
`2`	`1`	`class OtherClass:`
`3`	`2`	`pass`