Project is a folder include its own configuration file, which used to manage obfuscated scripts.
There are several advantages to manage obfuscated scripts by Project:
- Increment build, only updated scripts are obfuscated since last build
- Filter obfuscated scripts in the project, exclude some scripts
- Obfuscate the scripts with different modes
- More convenient to manage obfuscated scripts
Managing Obfuscated Scripts With Project¶
Use command init to create a project:
cd examples/pybench pyarmor init --entry=pybench.py
It will create project configuration file
the current path. Or create project in another path:
pyarmor init --src=examples/pybench --entry=pybench.py projects/pybench
The project path projects/pybench will be created, and
.pyarmor_config will be saved there.
The common usage for project is to do any thing in the project path:
Show project information:
Obfuscate all the scripts in this project by command build:
Change the project configuration by command config.
For example, exclude the
test, the .py files in these
folder will not be obfuscated:
pyarmor config --manifest "include *.py, prune dist, prune test"
pyarmor build --force
Run obfuscated script:
cd dist python pybench.py
After some scripts changed, just run build again:
cd projects/pybench pyarmor build
Obfuscating Scripts With Different Modes¶
First configure the different modes, refer to The Modes of Obfuscated Scripts:
pyarmor config --obf-mod=1 --obf-code=0
Then obfuscating scripts in new mode:
pyarmor build -B
Project Configuration File¶
Each project has a configure file. It’s a json file named
.pyarmor_config stored in the project path.
Base path to match files by manifest template string.
It could be absolute path, or relative path based on project folder.
A string specifies files to be obfuscated, same as MANIFEST.in of Python Distutils, default value is:
It means all files anywhere in the src tree matching.
Multi manifest template commands are spearated by comma, for example:
global-include *.py, exclude __mainfest__.py, prune test
Available values: 0, 1, None
When it’s set to 1, the basename of src will be appended to output as the final path to save obfuscated scripts, but runtime files are still in the path output
When init a project and no
--typespecified, it will be set to 1 if there is __init__.py in the path src, otherwise it’s None.
Available values: 0, 1, 2, 3, 4
By default it’s set to 1.
Refer to Restrict Mode
A string includes one or many entry scripts.
When build project, insert the following bootstrap code for each entry:
from pytransform import pyarmor_runtime pyarmor_runtime()
The entry name is relative to src, or filename with absolute path.
Multi entries are separated by comma, for example:
main.py, another/main.py, /usr/local/myapp/main.py
Note that entry may be NOT obfuscated, if manifest does not specify this entry.
A path used to save output of build. It’s relative to project path.
Filename of project capsule. It’s relative to project path if it’s not absolute path.
How to obfuscate byte code of each code object:
Obfuscate each code object by default algorithm
Obfuscate each code object by more complex algorithm
The default value is 1, refer to Obfuscating Code Mode
Available values: 0, 1, None
Whether to wrap code object with try..final block.
The default value is 1, refer to Wrap Mode
How to obfuscate whole code object of module:
Obfuscate byte-code by DES algorithm
The default value is 1, refer to Obfuscating module Mode
How to proect dynamic library in obfuscated scripts:
Insert proection code with default template, refer to Special Handling of Entry Script
Read the template of protection code from this file other than default template.
None or any path.
When run obfuscated scripts, where to find dynamic library _pytransform. The default value is None, it means it’s within the Runtime Package or in the same path of
It’s useful when obfuscated scripts are packed into a zip file, for example, use py2exe to package obfuscated scripts. Set runtime_path to an empty string, and copy Runtime Files to same path of zip file, will solve this problem.
How to save the runtime files:
Save them in the same path with the obufscated scripts
- 1 (Default)
Save them in the sub-path pytransform as a package
Same as 1, but it’s implied the package pytransform is not in same path with obfuscated scripts in runtime. So the bootstrap code will always make absolute import without leading dots in entry script.
Same as 1, but it’s implied the package pytransform is in the same path with obfuscated scripts in runtime. So the bootstrap code will always make a relative import with leading dots in the entry script.
None or list of string
Extend license type of obfuscated scripts, multi-plugins are supported. For example:
plugins: ["check_ntp_time", "show_license_info"]
About the usage of plugin, refer to Using Plugin to Extend License Type