chore: use leading underscore for private objects

Author: Rogdham

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 - Raise an exception when attempting to decompress empty data
 - Add `ZstdFile.name` property
 - Deprecate `(de)compress_stream` functions
+- Use a leading `_` for private objects
 - Build wheels for Windows ARM64
 - Support for PyPy 3.11
 

setup.py

@@ -166,20 +166,20 @@ def do_setup():
 
     if CFFI:
         # Packages
-        packages = ['pyzstd', 'pyzstd.cffi']
+        packages = ['pyzstd', 'pyzstd._cffi']
 
         # Binary extension
-        kwargs['module_name'] = 'pyzstd.cffi._cffi_zstd'
+        kwargs['module_name'] = 'pyzstd._cffi._cffi_zstd'
 
         sys.path.append('build_script')
         import pyzstd_build_cffi
         binary_extension = pyzstd_build_cffi.get_extension(**kwargs)
     else:  # C implementation
         # Packages
-        packages = ['pyzstd', 'pyzstd.c']
+        packages = ['pyzstd', 'pyzstd._c']
 
         # Binary extension
-        kwargs['name'] = 'pyzstd.c._zstd'
+        kwargs['name'] = 'pyzstd._c._zstd'
         kwargs['sources'].append('src/bin_ext/pyzstd.c')
         if MULTI_PHASE_INIT:
             # Use multi-phase initialization (PEP-489) on CPython 3.11.

src/__init__.py

@@ -1,6 +1,6 @@
 try:
     # Import C implementation
-    from .c import (
+    from ._c import (
         CParameter,
         DParameter,
         EndlessZstdDecompressor,
@@ -11,8 +11,8 @@
         ZstdDecompressor,
         ZstdDict,
         ZstdError,
-        ZstdFileReader,
-        ZstdFileWriter,
+        ZstdFileReader as _ZstdFileReader,
+        ZstdFileWriter as _ZstdFileWriter,
         _ZSTD_CStreamSizes,
         _ZSTD_DStreamSizes,
         _finalize_dict,
@@ -29,7 +29,7 @@
 except ImportError:
     try:
         # Import CFFI implementation
-        from .cffi import (
+        from ._cffi import (
             CParameter,
             DParameter,
             EndlessZstdDecompressor,
@@ -40,8 +40,8 @@
             ZstdDecompressor,
             ZstdDict,
             ZstdError,
-            ZstdFileReader,
-            ZstdFileWriter,
+            ZstdFileReader as _ZstdFileReader,
+            ZstdFileWriter as _ZstdFileWriter,
             _ZSTD_CStreamSizes,
             _ZSTD_DStreamSizes,
             _finalize_dict,
@@ -64,8 +64,8 @@
             "   that has libzstd.dll should be added by os.add_dll_directory() function.\n"
             "2, Please install pyzstd module through pip, to ensure that compiled\n"
             "   .so/.pyd file matches the architecture/OS/Python.\n")
-from .zstdfile import ZstdFile, open
-from .seekable_zstdfile import SeekableFormatError, SeekableZstdFile
+from ._zstdfile import ZstdFile, open
+from ._seekable_zstdfile import SeekableFormatError, SeekableZstdFile
 
 from functools import wraps