功能手册

pyarmor init

创建工程

digraph G { node [shape=box, style=rounded, target="_top"] rankdir=LR opts [shape=record label="{-C|-s|-r|-x}"] init [label="pyarmor init"] conf [label="配置文件 .pyarmor/config"] init -> opts [label="传入选项" dir=back arrowtail=curve] rank=same { init -> conf [label="写入"] } }

创建工程

增加脚本/模块/包到工程

digraph G { node [shape=box, style=rounded, target="_top"] rankdir=LR opts [shape=record label="{-e|-m|-p}"] init [label="pyarmor init"] conf [label="配置文件 .pyarmor/config"] init -> opts [label="传入选项" dir=back arrowtail=curve] rank=same { init -> conf [label="写入"] } }

增加脚本/模块/包到工程

pyarmor env

显示工程配置

digraph G { node [shape=box, style=rounded, target="_top"] init [label="pyarmor env -p info"] conf [label="配置文件 .pyarmor/config"] info [label="工程信息"] rank=same { conf -> init [label="传入配置" arrowhead=curve] } init -> info [label="显示"] }

显示工程配置

修改工程配置

digraph G { node [shape=box, style=rounded, target="_top"] rankdir=LR opts [label="工程选项" href="../../docs/zh/configuration.html"] env [label="pyarmor env -p set opt value"] conf [label="配置文件 .pyarmor/config"] env -> opts [label="传入选项" dir=back arrowtail=curve] rank=same { env -> conf [label="写入"] } }

修改工程配置

pyarmor build

列出工程中包含的脚本/模块/包

digraph G { node [shape=box, style=rounded, target="_top"] conf [label="配置文件 .pyarmor/config" href="../../docs/zh/configuration.html"] build [label="pyarmor build --list"] items [label="显示工程中包含的所有脚本名称"] conf -> build [label="传入配置" arrowhead=curve] build -> items [label="根据项目选项配置进行搜索和过滤"] }

列出工程中包含的脚本/模块/包

生成重构型脚本

digraph G { node [shape=box, style=rounded, target="_top"] build [label="pyarmor build --rft" style="filled,rounded" fillcolor="wheat"] join1 [shape=point] items [label="依次处理每一个脚本"] conf [label="工程属性\n存放在 .pyarmor/config 中"] rules [shape=plaintext label="工程的重构选项\n存放在 .pyarmor/config 中"] autofix [shape=plain label="自动生成的重构规则\n存放在 .pyarmor/project/rft_autofix.rules"] p1 [label="应用重构规则"] rft [label="生成重构脚本"] build -> join1 join1 -> conf [dir=none] join1 -> items [label="得到工程中的脚本列表"] items -> p1 rank=same { p1 -> rft } p1 -> rules [arrowtail=curve dir=back] p1 -> autofix [arrowtail=curve dir=back] }

生成重构型脚本

使用自动修正模式重构复杂脚本

Pyarmor 目前实现三种自动修改模式

digraph G { node [shape=box, style=rounded, target="_top"] build [label="pyarmor build --autofix 1" style="filled,rounded" fillcolor="wheat"] join1 [shape=point] items [label="依次处理每一个脚本"] conf [label="工程属性\n存放在 .pyarmor/config 中"] rules [shape=plaintext label="工程的重构选项\n存放在 .pyarmor/config 中"] autofix [shape=component style="filled" fillcolor="tan" label="生成重构规则\n所有未知属性都不进行重命名\n保存规则到 .pyarmor/project/rft_autofix.rules"] p1 [label="应用重构规则"] rft [label="尝试重构脚本\n如果某一个属性无法确定是否需要重命名\n那么记录到未知属性表中"] loop [label="合并所有脚本生成的未知属性表"] build -> join1 join1 -> conf [dir=none] join1 -> items [label="得到工程中的脚本列表"] items -> p1 rank=same { p1 -> rft } p1 -> rules [arrowtail=curve dir=back] rft -> loop -> autofix rebuild [style="filled,rounded" fillcolor="wheat" label="再次构建工程\npyarmor build --rft"] test [label="运行重构后的脚本\npython dist/foo.py"] fb [label="是否出现 AttributeError?"] f2 [label="把该名称人工增加到排除列表\npyarmor env -p push rft:exclude_names xxxx"] autofix -> rebuild -> test -> fb fb -> f2 [label="提示名称 xxxx 错误"] f2 -> rebuild [label="循环修正，直到没有错误" headport=e tailport=e] }

重构复杂脚本自动修正模式一

digraph G { node [shape=box, style=rounded, target="_top"] build [label="pyarmor build --autofix 2" style="filled,rounded" fillcolor="wheat"] join1 [shape=point] items [label="依次处理每一个脚本"] conf [label="工程属性\n存放在 .pyarmor/config 中"] rules [shape=plaintext label="工程的重构选项\n存放在 .pyarmor/config 中"] p1 [label="应用重构规则"] rft [label="尝试重构脚本\n记录不知道如何处理的属性\n生成未知属性表"] u1 [label="读取所有内置类型\n例如 int, list 等的属性\n读取重构选项 external_types\n得到所有外部导入类型的属性"] un [label="合并内置和外部类型的属性\n生成外部属性表"] u1 -> un autofix [shape=component style="filled" fillcolor="tan" label="生成重构规则\n未知属性和外部属性的交集都不进行重命名\n其他未知属性都进行重命名\n保存规则到 .pyarmor/project/rft_autofix.rules"] un -> autofix build -> join1 join1 -> conf [dir=none] join1 -> items [label="得到工程中的脚本列表"] items -> p1 rank=same { p1 -> rft [dir=normal] } p1 -> rules [arrowtail=curve dir=back] rft -> autofix rebuild [style="filled,rounded" fillcolor="wheat" label="再次构建工程\npyarmor build --rft"] test [label="运行重构后的脚本\npython dist/foo.py"] fb [label="是否出现 AttributeError?"] f1 [label="如果该名称是混淆后的名称\n在 .pyarmor/project/rft_autofix.rules 搜索该名称\n找到原来的名称"] f2 [label="把原来的名称人工增加到排除列表\npyarmor env -p push rft:exclude_names xxxx"] f3 [label="高级修正方法"] f4 [label="查看日志文件（Emacs org-mode）\n.pyarmor/rft_autofix.2.org"] f5 [label="浏览日志中已经重命名的属性名称\n如果该属性属于外部类型\n那么将该属性增加到配置文件中\npyarmor env -p push external_attrs XXXX"] f6 [label="重新开始修正循环\npyarmor build --autofix 2" style="filled,rounded" fillcolor="wheat"] autofix -> rebuild -> test -> fb fb -> f1 [label="提示名称 xxxx 错误"] f1 -> f2 [label="简单修正方法"] f2 -> rebuild [label="循环修正，直到没有错误" tailport=e] f1 -> f3 -> f4 -> f5 -> f6 }

重构复杂脚本自动修正模式二

digraph G { node [shape=box, style=rounded, target="_top"] build [label="pyarmor build --autofix 3" style="filled,rounded" fillcolor="wheat"] join1 [shape=point] items [label="依次处理每一个脚本"] conf [label="工程属性\n存放在 .pyarmor/config 中"] rules [shape=plaintext label="工程的重构选项\n存放在 .pyarmor/config 中"] p1 [label="应用重构规则"] rft [label="尝试重构每一个脚本"] n1 [label="记录工程内部模块定义的类型\n合并所有内部类型的属性\n生成内部属性表"] n2 [label="记录所有的未知属性\n生成未知属性表"] autofix [shape=component style="filled" fillcolor="tan" label="生成重构规则，保存到\n.pyarmor/project/rft_autofix.rules\n所有内部属性名称都会进行重命名"] autolog [shape=box style="filled,rounded" fillcolor="tan" label="生成修正记录表\n.pyarmor/project/rft_autofix.3.org"] build -> join1 join1 -> conf [dir=none] join1 -> items [label="得到工程中的脚本列表"] items -> p1 rank=same { p1 -> rft } p1 -> rules [arrowtail=curve dir=back] rft -> n1 -> autofix rft -> n2 [tailport=e] n2 -> autolog m1 [label="人工生成重构规则"] autolog -> m1 [label="浏览修正记录表"] m1 -> autofix [label="增加重构规则"] rebuild [style="filled,rounded" fillcolor="wheat" label="再次构建工程\npyarmor build --rft"] test [label="运行重构后的脚本\npython dist/foo.py"] fb [label="是否出现 AttributeError?"] autofix -> rebuild -> test -> fb fb -> m1 [label="出现错误"] }

重构复杂脚本自动修正模式三

生成迷你型脚本

digraph G { node [shape=box, style=rounded, target="_top"] build [label="pyarmor build --mini" style="filled,rounded" fillcolor="wheat"] join1 [shape=point] items [label="依次处理每一个脚本"] conf [label="工程属性\n存放在 .pyarmor/config 中"] mini [label="生成迷你型加密脚本"] build -> join1 join1 -> conf [dir=none] join1 -> items [label="得到工程中的脚本列表"] items -> mini }

生成迷你型脚本