maya-umbrella 0.9.0__py2.py3-none-any.whl → 0.11.0__py2.py3-none-any.whl

maya_umbrella/_vendor/vendor.txt

@@ -0,0 +1 @@
+six==1.16.0

maya_umbrella/cleaner.py

@@ -5,13 +5,13 @@ import os
 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 @@ PACKAGE_NAME = "maya_umbrella"
 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/defender.py

@@ -15,6 +15,7 @@ from maya_umbrella.maya_funs import om
 
 # Global list to store IDs of Maya callbacks
 MAYA_UMBRELLA_CALLBACK_IDS = []
+MAYA_UMBRELLA_DEFENDER = None
 
 
 def _add_callbacks_id(id_):
@@ -115,10 +116,11 @@ class MayaVirusDefender(object):
 
     def stop(self):
         """Stop the MayaVirusDefender."""
-        for ids in MAYA_UMBRELLA_CALLBACK_IDS:
-            self.logger.debug("remove callback. %s", ids)
-            om.MSceneMessage.removeCallback(ids)
-            MAYA_UMBRELLA_CALLBACK_IDS.remove(ids)
+        while MAYA_UMBRELLA_CALLBACK_IDS:
+            for ids in MAYA_UMBRELLA_CALLBACK_IDS:
+                self.logger.debug("remove callback. %s", ids)
+                om.MSceneMessage.removeCallback(ids)
+                MAYA_UMBRELLA_CALLBACK_IDS.remove(ids)
 
     def get_unfixed_references(self):
         """Get the list of unfixed reference files.
@@ -155,7 +157,19 @@ def context_defender():
     Yields:
         MayaVirusDefender: An instance of MayaVirusDefender.
     """
-    defender = MayaVirusDefender()
+    defender = get_defender_instance()
     defender.stop()
     yield defender
     defender.setup()
+
+
+def get_defender_instance():
+    """Get the MayaVirusDefender instance.
+
+    Returns:
+        MayaVirusDefender: The MayaVirusDefender instance.
+    """
+    global MAYA_UMBRELLA_DEFENDER
+    if MAYA_UMBRELLA_DEFENDER is None:
+        MAYA_UMBRELLA_DEFENDER = MayaVirusDefender()
+    return MAYA_UMBRELLA_DEFENDER

maya_umbrella/filesystem.py

@@ -3,21 +3,18 @@ from contextlib import contextmanager
 import glob
 import importlib
 import json
+import logging
 import os
 import random
 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():
@@ -42,20 +39,23 @@ def safe_rmtree(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 ""
+    """Read the file content.
+
+    Args:
+        path (str): File path of source.
+
+    Returns:
+         str: The contents of the file path.
+
+    """
+    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_)
@@ -66,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.
@@ -89,14 +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()))
-    with open(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))
@@ -173,7 +171,7 @@ def get_log_file():
     return os.path.join(root, "{name}.log".format(name=name))
 
 
-def remove_virus_file_by_signature(file_path, signatures, output_file_path=None):
+def remove_virus_file_by_signature(file_path, signatures, output_file_path=None, auto_remove=True):
     """Remove virus content from a file by matching signatures.
 
     Args:
@@ -181,11 +179,18 @@ def remove_virus_file_by_signature(file_path, signatures, output_file_path=None)
         signatures (list): List of signatures to match and remove.
         output_file_path (str, optional): Path to the cleaned output file.
          Defaults to None, which overwrites the input file.
+        auto_remove: If True, remove the input file if the output file is empty.
+
     """
     data = read_file(file_path)
     if check_virus_by_signature(data, signatures):
-        fixed_data = replace_content_by_signatures(data, signatures)
-        write_file(output_file_path or file_path, fixed_data)
+        fixed_data = replace_content_by_signatures(data, signatures).strip()
+        if fixed_data:
+            write_file(output_file_path or file_path, fixed_data)
+        else:
+            # Auto remove empty files.
+            if auto_remove:
+                os.remove(file_path)
 
 
 def replace_content_by_signatures(content, signatures):
@@ -199,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
 
 
@@ -216,11 +221,11 @@ def check_virus_file_by_signature(file_path, signatures=None):
     signatures = signatures or FILE_VIRUS_SIGNATURES
     try:
         data = read_file(file_path)
-        return check_virus_by_signature(data, signatures)
     except (OSError, IOError):  # noqa: UP024
         return False
     except UnicodeDecodeError:
-        return True
+        data = ""
+    return check_virus_by_signature(data, signatures)
 
 
 def check_virus_by_signature(content, signatures=None):
@@ -235,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
 
@@ -269,7 +274,8 @@ def get_backup_path(path, root_path=None):
 
 def get_maya_install_root(maya_version):
     """Get the Maya install root path."""
-    maya_location = os.environ.get("MAYA_LOCATION")
+    logger = logging.getLogger(__name__)
+    maya_location = os.getenv("MAYA_LOCATION")
     try:
         # Import built-in modules
         import winreg
@@ -282,14 +288,14 @@ def get_maya_install_root(maya_version):
         )
         root, _ = winreg.QueryValueEx(key, "MAYA_INSTALL_LOCATION")
         if not os.path.isdir(root):
-            print("Failed to locate the appropriate Maya path in the registration list.")
+            logger.info("Failed to locate the appropriate Maya path in the registration list.")
     except OSError:
         return maya_location
     maya_location = maya_location or root
     if not maya_location:
-        print("maya not found.")
+        logger.info("maya not found.")
         return
     maya_exe = os.path.join(maya_location, "bin", "maya.exe")
     if not os.path.exists(maya_exe):
-        print("maya.exe not found in {maya_location}.".format(maya_location=maya_location))
+        logger.info("maya.exe not found in {maya_location}.".format(maya_location=maya_location))
     return maya_location

maya_umbrella/hooks/delete_unknown_plugin_node.py

@@ -6,26 +6,26 @@ def hook(virus_cleaner):
     unknown_node = cmds.ls(type="unknown")
     unknown_plugin = cmds.unknownPlugin(query=True, l=True)
     if unknown_node:
-        for nodeObj in unknown_node:
-            if cmds.objExists(nodeObj):
-                if cmds.referenceQuery(nodeObj, isNodeReferenced=True):
-                    virus_cleaner.logger.warning("Node from reference, skip. {}".format(nodeObj))
+        for node_obj in unknown_node:
+            if cmds.objExists(node_obj):
+                if cmds.referenceQuery(node_obj, isNodeReferenced=True):
+                    virus_cleaner.logger.warning("Node from reference, skip. {}".format(node_obj))
                     continue
-                if cmds.lockNode(nodeObj, query=True)[0]:
+                if cmds.lockNode(node_obj, query=True)[0]:
                     try:
-                        cmds.lockNode(nodeObj, lock=False)
+                        cmds.lockNode(node_obj, lock=False)
                     except Exception:
                         virus_cleaner.logger.warning(
-                            "The node is locked and cannot be unlocked. skip {}".format(nodeObj)
+                            "The node is locked and cannot be unlocked. skip {}".format(node_obj)
                         )
                         continue
                 try:
-                    cmds.delete(nodeObj)
-                    virus_cleaner.logger.warning("Delete node: {}".format(nodeObj))
+                    cmds.delete(node_obj)
+                    virus_cleaner.logger.warning("Delete node: {}".format(node_obj))
                 except Exception:
                     pass
 
     if unknown_plugin:
-        for plugObj in unknown_plugin:
-            cmds.unknownPlugin(plugObj, remove=True)
-            virus_cleaner.logger.warning("Delete plug-in: {}".format(plugObj))
+        for plug_obj in unknown_plugin:
+            cmds.unknownPlugin(plug_obj, remove=True)
+            virus_cleaner.logger.warning("Delete plug-in: {}".format(plug_obj))

maya_umbrella/i18n.py

@@ -16,6 +16,7 @@ class Translator(object):
         data (dict): Dictionary containing translation data for different locales.
         locale (str): The current locale.
     """
+
     def __init__(self, file_format="json", default_locale=None):
         """Initialize the Translator.
 
@@ -24,8 +25,7 @@ class Translator(object):
             default_locale (str, optional): Default locale to use for translations. Defaults to None,
             which uses the MAYA_UMBRELLA_LANG environment variable or the Maya UI language.
         """
-        _default_locale = os.getenv("MAYA_UMBRELLA_LANG", maya_ui_language())
-        default_locale = default_locale or _default_locale
+        default_locale = default_locale or os.getenv("MAYA_UMBRELLA_LANG", maya_ui_language())
         self.data = {}
         self.locale = default_locale
         translations_folder = os.path.join(this_root(), "locales")

maya_umbrella/log.py

@@ -1,5 +1,7 @@
 # Import built-in modules
-import logging.handlers
+from logging import Formatter
+from logging import getLogger
+from logging import handlers
 import os
 
 # Import local modules
@@ -20,18 +22,18 @@ def setup_logger(logger=None, logfile=None, log_level=None):
     Returns:
         logging.Logger: The set up logger.
     """
-    logger = logger or logging.getLogger(PACKAGE_NAME)
+    logger = logger or getLogger(PACKAGE_NAME)
     log_level = log_level or os.getenv("MAYA_UMBRELLA_LOG_LEVEL", "INFO")
     logger.setLevel(log_level)
     logfile = logfile or get_log_file()
     if not len(logger.handlers):
-        filehandler = logging.handlers.RotatingFileHandler(
+        filehandler = handlers.RotatingFileHandler(
             logfile,
             mode="a",
             backupCount=7,
             delay=True,
             maxBytes=LOG_MAX_BYTES,
         )
-        filehandler.setFormatter(logging.Formatter(LOG_FORMAT))
+        filehandler.setFormatter(Formatter(LOG_FORMAT))
         logger.addHandler(filehandler)
     return logger

maya_umbrella/maya_funs.py

@@ -137,7 +137,7 @@ def save_as_file(file_name):
         file_name (str): Path to the output file.
     """
     cmds.file(rename=file_name)
-    cmds.file(s=True, f=True)
+    cmds.file(save=True, force=True)
 
 
 @contextmanager

maya_umbrella/scanner.py

@@ -6,6 +6,7 @@ import shutil
 
 # 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
@@ -30,7 +31,7 @@ class MayaVirusScanner(object):
 
         Args:
             output_path (str, optional): Path to save the fixed files. Defaults to None, which overwrites the original
-            files.
+                files.
             env (dict, optional): Custom environment variables. Defaults to None,
             which sets the 'MAYA_COLOR_MANAGEMENT_SYNCOLOR' variable to '1'.
         """
@@ -45,14 +46,23 @@ class MayaVirusScanner(object):
             "MAYA_COLOR_MANAGEMENT_SYNCOLOR": "1"
         }
 
-    def scan_files_from_pattern(self, pattern):
+    def scan_files_from_pattern(self, pattern, glob_options=None):
         """Scan and fix Maya files matching a given pattern.
 
         Args:
             pattern (str): The file pattern to match.
+            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))
+        return self.scan_files_from_list(glob.iglob(pattern, **glob_options))
 
     def scan_files_from_list(self, files):
         """Scan and fix Maya files from a given list.
@@ -99,7 +109,7 @@ class MayaVirusScanner(object):
             backup_path = get_backup_path(maya_file, root_path=self.output_path)
             self.logger.debug("Backup saved to: {backup_path}".format(backup_path=backup_path))
             shutil.copy2(maya_file, backup_path)
-            cmds.file(s=True, f=True)
+            cmds.file(save=True, force=True)
             self._fixed_files.append(maya_file)
             self._reference_files.extend(self.defender.collector.infected_reference_files)
         cmds.file(new=True, force=True)

maya_umbrella/signatures.py

@@ -8,3 +8,17 @@ VirusSignature = namedtuple("VirusSignature", ["name", "signature"])
 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

@@ -1,13 +1,13 @@
 # Import built-in modules
-import os.path
+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
 
 
@@ -42,10 +42,12 @@ class Vaccine(AbstractVaccine):
 
     def collect_infected_user_setup_py(self):
         """Collect all bad userSetup.py files related to the virus."""
-        for user_setup_py in [
+        user_setup_py_files = [
             os.path.join(self.api.local_script_path, "userSetup.py"),
             os.path.join(self.api.user_script_path, "userSetup.py"),
-        ]:
+        ]
+
+        for user_setup_py in user_setup_py_files:
             if os.path.exists(user_setup_py):
                 if check_virus_file_by_signature(user_setup_py):
                     self.report_issue(user_setup_py)

maya_umbrella/vaccines/vaccine3.py

@@ -3,13 +3,13 @@ import glob
 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
 
 
@@ -18,37 +18,47 @@ class Vaccine(AbstractVaccine):
 
     virus_name = "Virus2024429"
 
+    @staticmethod
+    def is_infected(script_node):
+        """Check if a script node is infected with a virus.
+
+        Args:
+            script_node (str): The name of the script node to check.
+
+        Returns:
+            bool: True if the script node is infected, False otherwise.
+        """
+        if "_gene" in script_node:
+            return True
+        if "uifiguration" in script_node:
+            for attr_name in ("before", "notes"):
+                script_string = get_attr_value(script_node, attr_name)
+                if script_string and check_virus_by_signature(script_string, JOB_SCRIPTS_VIRUS_SIGNATURES):
+                    return True
+        return False
+
     def collect_infected_nodes(self):
         """Collect all bad nodes related to the virus."""
         for script_node in cmds.ls(type="script"):
-            # check vaccine
-            if "_gene" in script_node:
+            if self.is_infected(script_node):
                 self.report_issue(script_node)
                 self.api.add_infected_node(script_node)
                 self.api.add_infected_reference_file(get_reference_file_by_node(script_node))
-            if "uifiguration" in script_node:
-                for attr_name in ("before", "notes"):
-                    script_string = get_attr_value(script_node, attr_name)
-                    if not script_string:
-                        continue
-                if check_virus_by_signature(script_string, JOB_SCRIPTS_VIRUS_SIGNATURES):
-                    self.report_issue(script_node)
-                    self.api.add_infected_node(script_node)
-                    self.api.add_infected_reference_file(get_reference_file_by_node(script_node))
 
     def collect_infected_mel_files(self):
         """Collect all bad MEL files related to the virus."""
         # check usersetup.mel
         # C:/Users/hallong/Documents/maya/scripts/usersetup.mel
         # C:/Users/hallong/Documents/maya/xxxx/scripts/usersetup.mel
-        for usersetup_mel in [
+        usersetup_mel_paths = [
             os.path.join(self.api.local_script_path, "usersetup.mel"),
             os.path.join(self.api.user_script_path, "usersetup.mel"),
-        ]:
-            if os.path.exists(usersetup_mel):
-                if check_virus_file_by_signature(usersetup_mel):
-                    self.report_issue(usersetup_mel)
-                    self.api.add_infected_file(usersetup_mel)
+        ]
+
+        for usersetup_mel in usersetup_mel_paths:
+            if os.path.exists(usersetup_mel) and check_virus_file_by_signature(usersetup_mel):
+                self.report_issue(usersetup_mel)
+                self.api.add_infected_file(usersetup_mel)
 
     def collect_script_jobs(self):
         """Collect all script jobs related to the virus."""

{maya_umbrella-0.9.0.dist-info → maya_umbrella-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maya_umbrella
-Version: 0.9.0
+Version: 0.11.0
 Summary: Check and fix maya virus.
 Home-page: https://github.com/loonghao/maya_umbrella
 License: MIT
@@ -78,22 +78,25 @@ and it is recommended to use Python 3.8 or higher versions.
 
 通过虚拟环境去设置开发环境, 推荐python-3.8以上的版本
 
+通过pip安装相关开发依赖
+
 ```shell
-pip install nox poetry
+pip install -r requirements-dev.txt
 ```
 
 # 开发调试
 
-```shell
-nox -s maya -- 2020 --test
-```
 
 ## 在maya中测试
 
 通过`nox -s maya -- <maya version>`, 启动maya.
 nox会动态根据你本地安装得maya去注册nox session, 比如你本地安装了`maya-2020`，
+那么通过可以启动带有测试环境的maya
+```shell
+nox -s maya -- 2018
+```
 
-那么通过`nox -s maya -- 2018`, **注意：maya 与 版本号之间有 俩个`-`**
+**注意：maya 与 版本号之间有 俩个`-`**
 
 启动maya后在脚本编辑器中执行下面得代码，就会动态的从`<repo>/tests/virus/`里面去open ma文件去进行测试.
 
@@ -103,6 +106,15 @@ import manual_test_in_maya
 manual_test_in_maya.start()
 ```
 
+也可以通过pytest去执行对应的测试，也需要本地安装了对应的maya
+
+```shell
+nox -s maya -- 2018 --test
+```
+
+**注意：在maya-2022 (PY2) 以下的版本可能会出现命令行crash的情况**
+
+
 ## 增加新的疫苗
 
 在`<repo>/maya_umbrella/vaccines/` 新建一个py, 因为有很多病毒没有具体的名字代号，我们统一以`vaccine<id>.py`
@@ -113,13 +125,20 @@ manual_test_in_maya.start()
 我们可以利用封装好的`nox`命令去执行进行代码检查
 
 ```shell
-nox -s ruff_check
+nox -s lint
+```
+
+进行代码整理
+```shell
+nox -s lint-fix
 ```
 
 # 生成安装包
 
 执行下面的命令可以在<repo>/.zip下面创建zip，参数 `--version` 当前工具的版本号
- **注意：`make-zip` 与 `--version`之间有 俩个`-`**
+
+**注意：`make-zip` 与 `--version`之间有 俩个`-`**
+
 ```shell
 nox -s make-zip -- --version 0.5.0
 ```
@@ -162,14 +181,20 @@ MAYA_UMBRELLA_LANG
 MAYA_UMBRELLA_IGNORE_BACKUP
 ```
 
+如果忽略请设置为
+```shell
+SET MAYA_UMBRELLA_IGNORE_BACKUP=true
+```
+
 如果是便携版Maya，可以通过添加 `MAYA_LOCATION` 环境变量指定Maya路径
 ```shell
 SET MAYA_LOCATION=d:/your/path/maya_version/
 ```
+也可以通过命令行指定目录
 
-如果忽略请设置为
 ```shell
-SET MAYA_UMBRELLA_IGNORE_BACKUP=true
+nox -s maya -- 2018 --install-root /your/local/maya/root
+
 ```
 
 # API
@@ -192,13 +217,16 @@ print(api.scan_files_from_pattern("your/path/*.m[ab]"))
 ```
 
 # 案例
-如果你想要快速通过maya standalone去批量清理maya文件，可以`下载`或者`git clone`当前`main`分支的工程，
-根据上面指引设置好开发环境
-通过`nox`命令去启动maya `standalone`环境，maya版本根据你当前本地安装的maya为准，比如你本地安装了`2018`,
+如果你想要快速通过maya standalone去批量清理maya文件，
+可以`下载`或者`git clone`当前`main`分支的工程，
+根据上面指引设置好开发环境,
+通过`nox`命令去启动maya `standalone`环境，maya版本根据你当前本地安装的maya为准，
+比如你本地安装了`2018`,
 那么就是 `nox -s maya -- 2018 --standalone`
 下面的语法是启动一个maya-2020的环境去动态从`c:/test`文件夹下去查杀病毒
+
 ```shell
-nox -s maya-2020-s -- c:/test/*.m[ab]
+nox -s maya -- 2018 --standalone --pattern c:/test/*.m[ab]
 ```
 
 ## Contributors ✨