minor cleanups

Author: mara004

conda/raw/recipe/meta.yaml

@@ -51,7 +51,7 @@ about:
   summary: Python bindings to PDFium (raw, external binary)
   description: |
     This package provides raw ctypes bindings to pdfium.
-    Note, dependants should not pin this package to an exact version, as pypdfium2_raw itself pins pdfium-binaries to achieve ABI safety.
+    Note, dependants should not pin this package to an exact version, as pypdfium2_raw itself pins pdfium-binaries for ABI safety reasons.
     In general, pypdfium2_helpers is the canonical package (i.e. roughly equivalent to pypdfium2 on PyPI), so it is recommended to depend on that rather than on pypdfium2_raw directly.
   license: BSD-3-Clause, Apache-2.0
   license_file:

setupsrc/pypdfium2_setup/autorelease.py

@@ -23,7 +23,7 @@ def run_local(*args, **kws):
 def update_refbindings(version):
 
     # We endeavor to make the reference bindings as universal and robust as possible, thus the symbol guards, flags, runtime libdir ["."] + system search.
-    # Also, skip symbol source info to make for cleaner diffs, so one can see pdfium API changes at a glance.
+    # Also, skip symbol source info for cleaner diffs, so one can see pdfium API changes at a glance.
 
     # REFBINDINGS_FLAGS:
     # Given the symbol guards, we can define all standalone feature flags.
@@ -44,7 +44,6 @@ def do_versioning(config, record, prev_helpers, new_pdfium):
     if prev_helpers["dirty"]:
         print("Warning: dirty state. This should not happen in CI.", file=sys.stderr)
 
-    # TODO actually, we care only about updates to src/
     py_updates = prev_helpers["n_commits"] > 0
     c_updates = record["pdfium"] < new_pdfium
 

setupsrc/pypdfium2_setup/base.py

@@ -207,7 +207,7 @@ def parse_given_tag(full_tag):
 
     info = dict()
 
-    # NOTE `git describe --dirty` does not account for new unregistered files
+    # note, git describe --dirty ignores new unregistered files
     tag = full_tag
     dirty = tag.endswith("-dirty")
     if dirty:
@@ -237,7 +237,7 @@ def parse_git_tag():
 
 def merge_tag(info, mode):
 
-    # FIXME some duplication with src/pypdfium2/version.py
+    # some duplication with src/pypdfium2/version.py ...
 
     tag = ".".join([str(info[k]) for k in ("major", "minor", "patch")])
     if info['beta'] is not None:
@@ -264,13 +264,13 @@ def plat_to_system(pl_name):
     if pl_name == ExtPlats.sourcebuild:
         # FIXME If doing a sourcebuild on an unknown host system, this returns None, which will cause binary detection code to fail (we need to know the platform-specific binary name) - handle this downsteam with fallback value?
         return Host.system
-    # NOTE other ExtPlats not supported here
+    # other ExtPlats intentionally not handled here
     return getattr(SysNames, pl_name.split("_", maxsplit=1)[0])
 
 
 # platform.libc_ver() currently returns an empty string for musl, so use the packaging module to confirm.
 # See https://github.com/python/cpython/issues/87414 and https://github.com/pypa/packaging/blob/f13c298f0a623f3f7e01cc8395956b718d21503a/src/packaging/_musllinux.py#L32
-# NOTE could consider packaging.tags.sys_tags() as a possible public-API alternative - see https://packaging.pypa.io/en/stable/tags.html#packaging.tags.sys_tags or https://stackoverflow.com/a/75172415/15547292
+# (could consider packaging.tags.sys_tags() as a possible public-API alternative - see https://packaging.pypa.io/en/stable/tags.html#packaging.tags.sys_tags or https://stackoverflow.com/a/75172415/15547292)
 
 def _get_libc_info():
 
@@ -296,10 +296,9 @@ def __init__(self):
         self._system_name = platform.system().lower()
         self._machine_name = platform.machine().lower()
 
-        # If we are on Linux, check if we have glibc or musl
+        # If we are on Linux, check which libc we have
         self._libc_name, self._libc_ver = _get_libc_info()
 
-        # TODO consider cached property for platform and system?
         try:
             self.platform = self._get_platform()
         except Exception as e:
@@ -362,7 +361,7 @@ def _get_platform(self):
             elif self._machine_name == "i686":
                 return PlatNames.android_x86
         elif self._system_name in ("iOS", "iPadOS"):  # PEP 730
-            # NOTE iOS detection is untested. We don't have access to an iOS device, so this is basically guessed from what the PEP mentions.
+            # This is currently untested. We don't have access to an iOS device, so this is basically guessed from what the PEP mentions.
             ios_ver = platform.ios_ver()
             if self._machine_name == "arm64":
                 return PlatNames.ios_arm64_simu if ios_ver.is_simulator else PlatNames.ios_arm64_dev
@@ -420,7 +419,7 @@ def get_wheel_tag(pl_name):
     elif pl_name == PlatNames.android_x86:
         return "android_21_x86"
     # iOS - see PEP 730 # Packaging
-    # We do not currently build wheels for iOS, but again, add the handlers so it could be done on demand. Bear in mind that iOS is currently completely untested. In particular, the PEP says
+    # We do not currently build wheels for iOS, but again, add the handlers so it could be done on demand. Bear in mind that the resulting iOS packages are currently completely untested. In particular, the PEP says
     # "These wheels can include binary modules in-situ (i.e., co-located with the Python source, in the same way as wheels for a desktop platform); however, they will need to be post-processed as binary modules need to be moved into the “Frameworks” location for distribution. This can be automated with an Xcode build step."
     # I take it this means you may need to change the library search path to that Frameworks location.
     elif pl_name == PlatNames.ios_arm64_dev:
@@ -605,7 +604,7 @@ def clean_platfiles():
 
 def get_helpers_info():
 
-    # TODO consider adding some checks against record
+    # TODO add some checks against record?
 
     have_git_describe = False
     if HAVE_GIT_REPO:

setupsrc/pypdfium2_setup/emplace.py

@@ -17,8 +17,6 @@ def _repr_info(version, flags):
 
 def _get_pdfium_with_cache(pl_name, req_ver, req_flags, use_v8):
 
-    # TODO inline binary cache logic into update.py ?
-    
     system = plat_to_system(pl_name)
     pl_dir = DataDir / pl_name
     binary = pl_dir / libname_for_system(system)

setupsrc/pypdfium2_setup/update.py

@@ -98,6 +98,7 @@ def main(platforms, version=None, robust=False, max_workers=None, use_v8=False):
 # low-level CLI interface for testing - users should go with higher-level emplace.py or setup.py
 
 def parse_args(argv):
+    platform_choices = list(PdfiumBinariesMap.keys())
     parser = argparse.ArgumentParser(
         description = "Download pre-built PDFium packages.",
     )
@@ -106,8 +107,8 @@ def parse_args(argv):
         "--platforms", "-p",
         nargs = "+",
         metavar = "ID",
-        choices = list(PdfiumBinariesMap.keys()),
-        help = f"The platform(s) to include. Defaults to the platforms we build wheels for. Choices: {list(PdfiumBinariesMap.keys())}",
+        choices = platform_choices,
+        help = f"The platform(s) to include. Defaults to the platforms we build wheels for. Choices: {platform_choices}",
     )
     parser.add_argument(
         "--use-v8",