Move modules into pyfuse3 package

If we want to export our type information, we're required to wrap our
modules in a package.  Do so, but leave compatbility wrappers in the
old locations.

Author: bgilbert

.gitignore

@@ -3,8 +3,8 @@ build/
 dist/
 doc/html/
 doc/doctrees/
-src/pyfuse3/pyfuse3.c
-src/pyfuse3/pyfuse3*.so
+src/pyfuse3/__init__.c
+src/pyfuse3/__init__*.so
 test/.cache/
 __pycache__
 test/.pytest_cache/

Changes.rst

@@ -4,6 +4,16 @@
 
 .. currentmodule:: pyfuse3
 
+Unreleased Changes
+==================
+
+* Move ``_pyfuse3`` to ``pyfuse3._pyfuse3`` and add a compatibility wrapper
+  for the old name.
+
+* Move ``pyfuse3_asyncio`` to ``pyfuse3.asyncio`` and add a compatibility
+  wrapper for the old name.
+
+
 Release 3.3.0 (2023-08-06)
 ==========================
 

examples/hello.py

@@ -29,8 +29,8 @@
 # to load the module from there first.
 basedir = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '..'))
 if (os.path.exists(os.path.join(basedir, 'setup.py')) and
-    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', 'pyfuse3.pyx'))):
-    sys.path.insert(0, os.path.join(basedir, 'src', 'pyfuse3'))
+    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', '__init__.pyx'))):
+    sys.path.insert(0, os.path.join(basedir, 'src'))
 
 from argparse import ArgumentParser
 import stat

examples/hello_asyncio.py

@@ -29,16 +29,16 @@
 # to load the module from there first.
 basedir = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '..'))
 if (os.path.exists(os.path.join(basedir, 'setup.py')) and
-    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', 'pyfuse3.pyx'))):
-    sys.path.insert(0, os.path.join(basedir, 'src', 'pyfuse3'))
+    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', '__init__.pyx'))):
+    sys.path.insert(0, os.path.join(basedir, 'src'))
 
 from argparse import ArgumentParser
 import asyncio
 import stat
 import logging
 import errno
 import pyfuse3
-import pyfuse3_asyncio
+import pyfuse3.asyncio
 
 try:
     import faulthandler
@@ -48,7 +48,7 @@
     faulthandler.enable()
 
 log = logging.getLogger(__name__)
-pyfuse3_asyncio.enable()
+pyfuse3.asyncio.enable()
 
 class TestFs(pyfuse3.Operations):
     def __init__(self):

examples/passthroughfs.py

@@ -46,8 +46,8 @@
 # to load the module from there first.
 basedir = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '..'))
 if (os.path.exists(os.path.join(basedir, 'setup.py')) and
-    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', 'pyfuse3.pyx'))):
-    sys.path.insert(0, os.path.join(basedir, 'src', 'pyfuse3'))
+    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', '__init__.pyx'))):
+    sys.path.insert(0, os.path.join(basedir, 'src'))
 
 import pyfuse3
 from argparse import ArgumentParser

examples/tmpfs.py

@@ -28,8 +28,8 @@
 # to load the module from there first.
 basedir = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '..'))
 if (os.path.exists(os.path.join(basedir, 'setup.py')) and
-    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', 'pyfuse3.pyx'))):
-    sys.path.insert(0, os.path.join(basedir, 'src', 'pyfuse3'))
+    os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', '__init__.pyx'))):
+    sys.path.insert(0, os.path.join(basedir, 'src'))
 
 import pyfuse3
 import errno

rst/asyncio.rst

@@ -6,13 +6,14 @@
 
 By default, pyfuse3 uses asynchronous I/O using Trio_ (and most of the
 documentation assumes that you are using Trio). If you'd rather use
-asyncio, import the *pyfuse3_asyncio* module and call its
-*enable()* function before using *pyfuse3*. For example::
+asyncio, import the *pyfuse3.asyncio* module (*pyfuse3_asyncio* in 3.3.0 and
+earlier) and call its *enable()* function before using *pyfuse3*.
+For example::
 
    import pyfuse3
-   import pyfuse3_asyncio
+   import pyfuse3.asyncio
 
-   pyfuse3_asyncio.enable()
+   pyfuse3.asyncio.enable()
 
    # Use pyfuse3 as usual from here on.
 

rst/conf.py

@@ -19,7 +19,7 @@
 # we need util/ so the sphinx_cython extension is found:
 sys.path.insert(0, os.path.join(basedir, 'util'))
 # we need src/ also, it is needed so llfuse can be imported to generate api docs:
-sys.path.insert(0, os.path.join(basedir, 'src', 'pyfuse3'))
+sys.path.insert(0, os.path.join(basedir, 'src'))
 
 #pylint: disable-all
 #@PydevCodeAnalysisIgnore

setup.py

@@ -89,7 +89,7 @@ def main():
 
     link_args = pkg_config('fuse3', cflags=False, ldflags=True, min_ver='3.2.0')
     link_args.append('-lpthread')
-    c_sources = ['src/pyfuse3/pyfuse3.c']
+    c_sources = ['src/pyfuse3/__init__.c']
 
     if os.uname()[0] in ('Linux', 'GNU/kFreeBSD'):
         link_args.append('-lrt')
@@ -127,10 +127,11 @@ def main():
           install_requires=['trio >= 0.15'],
           tests_require=['pytest >= 3.4.0', 'pytest-trio'],
           python_requires='>=3.8',
-          package_dir={'': 'src/pyfuse3'},
+          package_dir={'': 'src'},
+          packages=['pyfuse3'],
           py_modules=['_pyfuse3', 'pyfuse3_asyncio'],
           provides=['pyfuse3'],
-          ext_modules=[Extension('pyfuse3', c_sources,
+          ext_modules=[Extension('pyfuse3.__init__', c_sources,
                                   extra_compile_args=compile_args,
                                   extra_link_args=link_args)],
           cmdclass={'build_cython': build_cython},

src/_pyfuse3.py

@@ -0,0 +1,15 @@
+'''
+_pyfuse3.py
+
+Compatibility redirect: Pure-Python components of pyfuse3.
+
+Copyright © 2018 Nikolaus Rath <Nikolaus.org>
+
+This file is part of pyfuse3. This work may be distributed under
+the terms of the GNU LGPL.
+'''
+
+from pyfuse3 import _pyfuse3
+import sys
+
+sys.modules['_pyfuse3'] = _pyfuse3

src/pyfuse3/pyfuse3.pyi src/pyfuse3/__init__.pyi

@@ -1,15 +1,15 @@
 '''
-pyfuse3.pyi
+__init__.pyi
 
-Type annotation stubs for the external API in pyfuse3.pyx.
+Type annotation stubs for the external API in __init__.pyx.
 
 Copyright © 2021 Oliver Galvin
 
 This file is part of pyfuse3. This work may be distributed under
 the terms of the GNU LGPL.
 '''
 
-from _pyfuse3 import Operations, async_wrapper, FileHandleT, FileNameT, FlagT, InodeT, ModeT
+from ._pyfuse3 import Operations, async_wrapper, FileHandleT, FileNameT, FlagT, InodeT, ModeT
 from typing import List, Literal, Mapping
 
 NamespaceT = Literal["system", "user"]

src/pyfuse3/pyfuse3.pyx src/pyfuse3/__init__.pyx

@@ -1,5 +1,5 @@
 '''
-pyfuse3.pyx
+__init__.pyx
 
 Copyright © 2013 Nikolaus Rath <Nikolaus.org>
 
@@ -19,7 +19,7 @@ cdef extern from "pyfuse3.h":
 ###########
 
 from fuse_lowlevel cimport *
-from macros cimport *
+from .macros cimport *
 from posix.stat cimport struct_stat, S_IFMT, S_IFDIR, S_IFREG
 from posix.types cimport mode_t, dev_t, off_t
 from libc.stdint cimport uint32_t
@@ -69,13 +69,13 @@ import trio
 import threading
 import typing
 
-import _pyfuse3
+from . import _pyfuse3
 _pyfuse3.FUSEError = FUSEError
 
-from _pyfuse3 import Operations, async_wrapper
+from ._pyfuse3 import Operations, async_wrapper
 
 if typing.TYPE_CHECKING:
-    from _pyfuse3 import FileHandleT, FileNameT, FlagT, InodeT, ModeT
+    from ._pyfuse3 import FileHandleT, FileNameT, FlagT, InodeT, ModeT
 
 
 ##################

src/pyfuse3/pyfuse3_asyncio.py src/pyfuse3/asyncio.py

@@ -1,5 +1,5 @@
 '''
-pyfuse3_asyncio.py
+asyncio.py
 
 asyncio compatibility layer for pyfuse3
 
@@ -16,15 +16,15 @@
 from typing import Any, Callable, Iterable, Optional, Type
 
 import pyfuse3
-from _pyfuse3 import FileHandleT
+from ._pyfuse3 import FileHandleT
 
 Lock = asyncio.Lock
 
 
 def enable() -> None:
     '''Switch pyfuse3 to asyncio mode.'''
 
-    fake_trio = sys.modules['pyfuse3_asyncio']
+    fake_trio = sys.modules['pyfuse3.asyncio']
     fake_trio.lowlevel = fake_trio  # type: ignore
     fake_trio.from_thread = fake_trio  # type: ignore
     pyfuse3.trio = fake_trio  # type: ignore

src/pyfuse3/handlers.pxi

@@ -2,7 +2,7 @@
 handlers.pxi
 
 This file defines the FUSE request handlers. It is included
-by pyfuse3.pyx.
+by __init__.pyx.
 
 Copyright © 2013 Nikolaus Rath <Nikolaus.org>
 

src/pyfuse3/internal.pxi

@@ -2,7 +2,7 @@
 internal.pxi
 
 This file defines functions and data structures that are used internally by
-pyfuse3. It is included by pyfuse3.pyx.
+pyfuse3. It is included by __init__.pyx.
 
 Copyright © 2013 Nikolaus Rath <Nikolaus.org>
 
@@ -194,7 +194,7 @@ cdef class _WorkerData:
         self.task_serial += 1
         return 'pyfuse-%02d' % self.task_serial
 
-# Delay initialization so that pyfuse3_asyncio can replace
+# Delay initialization so that pyfuse3.asyncio can replace
 # the trio module.
 cdef _WorkerData worker_data
 

src/pyfuse3_asyncio.py

@@ -0,0 +1,16 @@
+'''
+asyncio.py
+
+Compatibility redirect: asyncio compatibility layer for pyfuse3
+
+Copyright © 2018 Nikolaus Rath <Nikolaus.org>
+Copyright © 2018 JustAnotherArchivist
+
+This file is part of pyfuse3. This work may be distributed under
+the terms of the GNU LGPL.
+'''
+
+from pyfuse3 import asyncio
+import sys
+
+sys.modules['pyfuse3_asyncio'] = asyncio

test/conftest.py

@@ -50,9 +50,9 @@ def pytest_configure(config):
     # modules from here
     basedir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
     if not config.getoption('installed'):
-        pyfuse3_path = os.path.join(basedir, 'src', 'pyfuse3')
+        pyfuse3_path = os.path.join(basedir, 'src')
         if (os.path.exists(os.path.join(basedir, 'setup.py')) and
-            os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', 'pyfuse3.pyx'))):
+            os.path.exists(os.path.join(basedir, 'src', 'pyfuse3', '__init__.pyx'))):
             sys.path.insert(0, pyfuse3_path)
 
         # Make sure that called processes use the same path