maya-umbrella 0.9.0__tar.gz → 0.11.0__tar.gz

{maya_umbrella-0.9.0 → maya_umbrella-0.11.0}/PKG-INFO

@@ -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 ✨

{maya_umbrella-0.9.0 → maya_umbrella-0.11.0}/README.md

@@ -53,22 +53,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文件去进行测试.
 
@@ -78,6 +81,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`
@@ -88,13 +100,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
 ```
@@ -137,14 +156,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
@@ -167,13 +192,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 ✨

{maya_umbrella-0.9.0 → maya_umbrella-0.11.0}/maya_umbrella/__init__.py

@@ -3,7 +3,16 @@ from maya_umbrella.cleaner import MayaVirusCleaner
 from maya_umbrella.collector import MayaVirusCollector
 from maya_umbrella.defender import MayaVirusDefender
 from maya_umbrella.defender import context_defender
+from maya_umbrella.defender import get_defender_instance
 from maya_umbrella.scanner import MayaVirusScanner
 
 
-__all__ = ["MayaVirusDefender", "MayaVirusCleaner", "MayaVirusCollector", "MayaVirusScanner", "context_defender"]
+# All public APIs.
+__all__ = [
+    "MayaVirusDefender",
+    "MayaVirusCleaner",
+    "MayaVirusCollector",
+    "MayaVirusScanner",
+    "context_defender",
+    "get_defender_instance",
+]

maya_umbrella-0.11.0/maya_umbrella/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.11.0"

maya_umbrella-0.11.0/maya_umbrella/_vendor/six/__init__.pyi

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

maya_umbrella-0.11.0/maya_umbrella/_vendor/six/moves/__init__.pyi

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

maya_umbrella-0.11.0/maya_umbrella/_vendor/six/moves/configparser.pyi

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

maya_umbrella-0.11.0/maya_umbrella/_vendor/six.LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010-2020 Benjamin Peterson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.