DR_Team/Difficult-Rocket
DR_Team/Difficult-Rocket
6
2
Fork 0
Code Issues Pull Requests Projects Releases 25 Wiki Activity

[build skip] linkcheck fixed

Browse Source
This commit is contained in:
shenjack 2023-01-18 00:02:09 +08:00
parent b3eb08dfd0
commit dc963ea28d
3 changed files with 685 additions and 560 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

437
docs/src/nuitka/20230116_nuitka_options.md
View File

@ -2,60 +2,79 @@
## [nuitka 所有编译选项原文](nuitka_options_137.md) ## [nuitka 所有编译选项原文](nuitka_options_137.md)
``` text ## 用法:
用法: __main__.py [--module] [--run] [options] main_module.py `__main__.py [--module] [--run] [options] main_module.py`
Options: ## 主要选项:
--help 展示这条信息，然后退出 - `--help`
--version Show version information and important details for bug - 展示这条信息，然后退出
reports, then exit. Defaults to off.
--module Create an extension module executable instead of a
program. Defaults to off.
--standalone Enable standalone mode for output. This allows you to
transfer the created binary to other machines without
it using an existing Python installation. This also
means it will become big. It implies these option: "--
follow-imports" and "--python-flag=no_site". Defaults
to off.
--onefile On top of standalone mode, enable onefile mode. This
means not a folder, but a compressed executable is
created and used. Defaults to off.
--python-debug Use debug version or not. Default uses what you are
using to run Nuitka, most likely a non-debug version.
--python-flag=FLAG Python flags to use. Default is what you are using to
run Nuitka, this enforces a specific mode. These are
options that also exist to standard Python executable.
Currently supported: "-S" (alias "no_site"),
"static_hashes" (do not use hash randomization),
"no_warnings" (do not give Python run time warnings),
"-O" (alias "no_asserts"), "no_docstrings" (do not use
doc strings), "-u" (alias "unbuffered") and "-m".
Default empty.
--python-for-scons=PATH
If using Python3.3 or Python3.4, provide the path of a
Python binary to use for Scons. Otherwise Nuitka can
use what you run Nuitka with or a Python installation
from Windows registry. On Windows Python 3.5 or higher
is needed. On non-Windows, Python 2.6 or 2.7 will do
as well.
Control the inclusion of modules and packages in result: - `--version`
--include-package=PACKAGE - 展示版本信息和用于汇报 bug 的重要细节，然后退出
Include a whole package. Give as a Python namespace, - 默认: `禁用`
e.g. "some_package.sub_package" and Nuitka will then
find it and include it and all the modules found below - `--module`
that disk location in the binary or extension module - 创建一个扩展而不是可执行程序
it creates, and make it available for import by the - 默认: `禁用`
code. To avoid unwanted sub packages, e.g. tests you
can e.g. do this "--nofollow-import-to=*.tests". - `--standalone`
Default empty. - 启用独立环境模式输出
--include-module=MODULE - 可以允许你将输出的内容直接复制到其他系统相同的电脑上并且不用安装 Python 环境
- 这也会意味着输出文件会变大
- 在启用此选项是同样意味着启用
- `--follow-imports`
- `--python-flag=no_site`
- 默认: `禁用`
- `--onefile`
- 基于独立环境模式的同时将输出内容变为单个可执行文件
- 默认: `禁用`
- `--python-debug`
- 是否使用 debug 版本
- 默认: 运行 nuitka 的 Python 版本
- `--python-flag=FLAG`
- Python 运行标志
- 这个标志会强制改变运行标志
- 目前受支持的选项
- `-S`: `no_site` 的缩写
- `static_hashes`: 禁用随机哈希
- `no_warnings`: 不输出 Python 的运行时警告
- `-O`: `no_asserts` 的缩写
- `no_docstrings`: 不在编译中包含注释
- `-u`: `unbuffered` 的缩写
- `-m`: 运行模块
- 默认: 运行 nuitka 的 Python 运行标志
- `--python-for-scons=PATH`
- 如果正在用 Python 3.3/3.4 将自动生成一个可以让 Scons 使用的 Python 二进制库
否则 nuitka 将使用运行 nuitka 的 Python 目录或者 Windows 注册表中的 Python 安装路径
在 Python 3.5+ 是需要的? 在 非 Windows 上 Python 2.6/2.7 也需要
## 控制包含模块和内容的选项:
- `--include-package=PACKAGE`
- 编译给定的整个模块和子包
- 输入格式: Python 命名空间
- 例如: `一个模块.的子包`
- nuitka 会寻找并编译这个包和他的所有子包，并且让给定的包可以在代码中引用
- 默认: 空
- `--include-module=MODULE`
- 编译给定的单个模块
- 输入格式: Python 命名空间
- 例如: `一个模块.的子包`
- nuitka 会寻找并编译这个模块
Include a single module. Give as a Python namespace, Include a single module. Give as a Python namespace,
e.g. "some_package.some_module" and Nuitka will then e.g. "some_package.some_module" and Nuitka will then
find it and include it in the binary or extension find it and include it in the binary or extension
module it creates, and make it available for import by module it creates, and make it available for import by
the code. Default empty. the code. Default empty.
--include-plugin-directory=MODULE/PACKAGE
- `--include-plugin-directory=MODULE/PACKAGE`
Include also the code found in that directory, Include also the code found in that directory,
considering as if they are each given as a main file. considering as if they are each given as a main file.
Overrides all other inclusion options. You ought to Overrides all other inclusion options. You ought to
@ -64,11 +83,13 @@ Options:
in "sys.path". This option is for very special use in "sys.path". This option is for very special use
cases only. Can be given multiple times. Default cases only. Can be given multiple times. Default
empty. empty.
--include-plugin-files=PATTERN
- `--include-plugin-files=PATTERN`
Include into files matching the PATTERN. Overrides all Include into files matching the PATTERN. Overrides all
other follow options. Can be given multiple times. other follow options. Can be given multiple times.
Default empty. Default empty.
--prefer-source-code
- `--prefer-source-code`
For already compiled extension modules, where there is For already compiled extension modules, where there is
both a source file and an extension module, normally both a source file and an extension module, normally
the extension module is used, but it should be better the extension module is used, but it should be better
@ -78,27 +99,33 @@ Options:
Default off. Default off.
Control the following into imported modules: Control the following into imported modules:
--follow-imports Descend into all imported modules. Defaults to on in
- `--follow-imports Descend into all imported modules. Defaults to on in`
standalone mode, otherwise off. standalone mode, otherwise off.
--follow-import-to=MODULE/PACKAGE
- `--follow-import-to=MODULE/PACKAGE`
Follow to that module if used, or if a package, to the Follow to that module if used, or if a package, to the
whole package. Can be given multiple times. Default whole package. Can be given multiple times. Default
empty. empty.
--nofollow-import-to=MODULE/PACKAGE
- `--nofollow-import-to=MODULE/PACKAGE`
Do not follow to that module name even if used, or if Do not follow to that module name even if used, or if
a package name, to the whole package in any case, a package name, to the whole package in any case,
overrides all other options. Can be given multiple overrides all other options. Can be given multiple
times. Default empty. times. Default empty.
--nofollow-imports Do not descend into any imported modules at all,
- `--nofollow-imports Do not descend into any imported modules at all,`
overrides all other inclusion options and not usable overrides all other inclusion options and not usable
for standalone mode. Defaults to off. for standalone mode. Defaults to off.
--follow-stdlib Also descend into imported modules from standard
- `--follow-stdlib Also descend into imported modules from standard`
library. This will increase the compilation time by a library. This will increase the compilation time by a
lot and is also not well tested at this time and lot and is also not well tested at this time and
sometimes won't work. Defaults to off. sometimes won't work. Defaults to off.
Onefile options: Onefile options:
--onefile-tempdir-spec=ONEFILE_TEMPDIR_SPEC
- `--onefile-tempdir-spec=ONEFILE_TEMPDIR_SPEC`
Use this as a folder to unpack to in onefile mode. Use this as a folder to unpack to in onefile mode.
Defaults to '%TEMP%/onefile_%PID%_%TIME%', i.e. user Defaults to '%TEMP%/onefile_%PID%_%TIME%', i.e. user
temporary directory and being non-static it's removed. temporary directory and being non-static it's removed.
@ -107,7 +134,8 @@ Options:
good static cache path, this will then not be removed. good static cache path, this will then not be removed.
Data files: Data files:
--include-package-data=PACKAGE
- `--include-package-data=PACKAGE`
Include data files for the given package name. DLLs Include data files for the given package name. DLLs
and extension modules are not data files and never and extension modules are not data files and never
included like this. Can use patterns the filenames as included like this. Can use patterns the filenames as
@ -119,9 +147,11 @@ Options:
selecting only matching files. Examples: "--include- selecting only matching files. Examples: "--include-
package-data=package_name" (all files) "--include- package-data=package_name" (all files) "--include-
package-data=package_name=*.txt" (only certain type) " package-data=package_name=*.txt" (only certain type) "
--include-package-data=package_name=some_filename.dat -
(concrete file) Default empty. - `--include-package-data=package_name=some_filename.dat
--include-data-files=DESC `` (concrete file) Default empty.
- `--include-data-files=DESC`
Include data files by filenames in the distribution. Include data files by filenames in the distribution.
There are many allowed forms. With '--include-data- There are many allowed forms. With '--include-data-
files=/path/to/file/*.txt=folder_name/some.txt' it files=/path/to/file/*.txt=folder_name/some.txt' it
@ -132,7 +162,8 @@ Options:
copy there is a form with 3 values that '--include- copy there is a form with 3 values that '--include-
data-files=/path/to/scan=folder_name=**/*.txt' that data-files=/path/to/scan=folder_name=**/*.txt' that
will preserve directory structure. Default empty. will preserve directory structure. Default empty.
--include-data-dir=DIRECTORY
- `--include-data-dir=DIRECTORY`
Include data files from complete directory in the Include data files from complete directory in the
distribution. This is recursive. Check '--include- distribution. This is recursive. Check '--include-
data-files' with patterns if you want non-recursive data-files' with patterns if you want non-recursive
@ -142,7 +173,8 @@ Options:
to exclude files you need to remove them beforehand, to exclude files you need to remove them beforehand,
or use '--noinclude-data-files' option to remove them. or use '--noinclude-data-files' option to remove them.
Default empty. Default empty.
--noinclude-data-files=PATTERN
- `--noinclude-data-files=PATTERN`
Do not include data files matching the filename Do not include data files matching the filename
pattern given. This is against the target filename, pattern given. This is against the target filename,
not source paths. So to ignore a file pattern from not source paths. So to ignore a file pattern from
@ -151,29 +183,35 @@ Options:
simply use "package_name". Default empty. simply use "package_name". Default empty.
DLL files: DLL files:
--noinclude-dlls=PATTERN
- `--noinclude-dlls=PATTERN`
Do not include DLL files matching the filename pattern Do not include DLL files matching the filename pattern
given. This is against the target filename, not source given. This is against the target filename, not source
paths. So ignore a DLL "someDLL" contained in the paths. So ignore a DLL "someDLL" contained in the
package "package_name" it should be matched as package "package_name" it should be matched as
"package_name/someDLL.*". Default empty. "package_name/someDLL.*". Default empty.
--list-package-dlls=LIST_PACKAGE_DLLS
- `--list-package-dlls=LIST_PACKAGE_DLLS`
Output the DLLs found for a given package name. Output the DLLs found for a given package name.
Default not done. Default not done.
Control the warnings to be given by Nuitka: Control the warnings to be given by Nuitka:
--warn-implicit-exceptions
- `--warn-implicit-exceptions`
Enable warnings for implicit exceptions detected at Enable warnings for implicit exceptions detected at
compile time. compile time.
--warn-unusual-code
- `--warn-unusual-code`
Enable warnings for unusual code detected at compile Enable warnings for unusual code detected at compile
time. time.
--assume-yes-for-downloads
- `--assume-yes-for-downloads`
Allow Nuitka to download external code if necessary, Allow Nuitka to download external code if necessary,
e.g. dependency walker, ccache, and even gcc on e.g. dependency walker, ccache, and even gcc on
Windows. To disable, redirect input from nul device, Windows. To disable, redirect input from nul device,
e.g. "</dev/null" or "<NUL:". Default is to prompt. e.g. "</dev/null" or "<NUL:". Default is to prompt.
--nowarn-mnemonic=MNEMONIC
- `--nowarn-mnemonic=MNEMONIC`
Disable warning for a given mnemonic. These are given Disable warning for a given mnemonic. These are given
to make sure you are aware of certain topics, and to make sure you are aware of certain topics, and
typically point to the Nuitka website. The mnemonic is typically point to the Nuitka website. The mnemonic is
@ -182,11 +220,14 @@ Options:
pattern. Default empty. pattern. Default empty.
Immediate execution after compilation: Immediate execution after compilation:
--run Execute immediately the created binary (or import the
- `--run Execute immediately the created binary (or import the`
compiled module). Defaults to off. compiled module). Defaults to off.
--debugger Execute inside a debugger, e.g. "gdb" or "lldb" to
- `--debugger Execute inside a debugger, e.g. "gdb" or "lldb" to`
automatically get a stack trace. Defaults to off. automatically get a stack trace. Defaults to off.
--execute-with-pythonpath
- `--execute-with-pythonpath`
When immediately executing the created binary or When immediately executing the created binary or
module using '--run', don't reset 'PYTHONPATH' module using '--run', don't reset 'PYTHONPATH'
environment. When all modules are successfully environment. When all modules are successfully
@ -194,19 +235,22 @@ Options:
and definitely not for standalone mode. and definitely not for standalone mode.
Compilation choices: Compilation choices:
--user-package-configuration-file=YAML_FILENAME
- `--user-package-configuration-file=YAML_FILENAME`
User provided Yaml file with package configuration. User provided Yaml file with package configuration.
You can include DLLs, remove bloat, add hidden You can include DLLs, remove bloat, add hidden
dependencies. Check User Manual for a complete dependencies. Check User Manual for a complete
description of the format to use. Can be given description of the format to use. Can be given
multiple times. Defaults to empty. multiple times. Defaults to empty.
--full-compat Enforce absolute compatibility with CPython. Do not
- `--full-compat Enforce absolute compatibility with CPython. Do not`
even allow minor deviations from CPython behavior, even allow minor deviations from CPython behavior,
e.g. not having better tracebacks or exception e.g. not having better tracebacks or exception
messages which are not really incompatible, but only messages which are not really incompatible, but only
different or worse. This is intended for tests only different or worse. This is intended for tests only
and should *not* be used. and should *not* be used.
--file-reference-choice=MODE
- `--file-reference-choice=MODE`
Select what value "__file__" is going to be. With Select what value "__file__" is going to be. With
"runtime" (default for standalone binary mode and "runtime" (default for standalone binary mode and
module mode), the created binaries and modules, use module mode), the created binaries and modules, use
@ -220,7 +264,8 @@ Options:
module_name>" is used. For compatibility reasons, the module_name>" is used. For compatibility reasons, the
"__file__" value will always have ".py" suffix "__file__" value will always have ".py" suffix
independent of what it really is. independent of what it really is.
--module-name-choice=MODE
- `--module-name-choice=MODE`
Select what value "__name__" and "__package__" are Select what value "__name__" and "__package__" are
going to be. With "runtime" (default for module mode), going to be. With "runtime" (default for module mode),
the created module uses the parent package to deduce the created module uses the parent package to deduce
@ -231,37 +276,47 @@ Options:
into any package. into any package.
Output choices: Output choices:
--output-filename=FILENAME
- `--output-filename=FILENAME`
Specify how the executable should be named. For Specify how the executable should be named. For
extension modules there is no choice, also not for extension modules there is no choice, also not for
standalone mode and using it will be an error. This standalone mode and using it will be an error. This
may include path information that needs to exist may include path information that needs to exist
though. Defaults to '<program_name>' on this platform. though. Defaults to '<program_name>' on this platform.
.exe .exe
--output-dir=DIRECTORY
- `--output-dir=DIRECTORY`
Specify where intermediate and final output files Specify where intermediate and final output files
should be put. The DIRECTORY will be populated with should be put. The DIRECTORY will be populated with
build folder, dist folder, binaries, etc. Defaults to build folder, dist folder, binaries, etc. Defaults to
current directory. current directory.
--remove-output Removes the build directory after producing the module
- `--remove-output Removes the build directory after producing the module`
or exe file. Defaults to off. or exe file. Defaults to off.
--no-pyi-file Do not create a ".pyi" file for extension modules
- `--no-pyi-file Do not create a ".pyi" file for extension modules`
created by Nuitka. This is used to detect implicit created by Nuitka. This is used to detect implicit
imports. Defaults to off. imports. Defaults to off.
Debug features: Debug features:
--debug Executing all self checks possible to find errors in
- `--debug Executing all self checks possible to find errors in`
Nuitka, do not use for production. Defaults to off. Nuitka, do not use for production. Defaults to off.
--unstripped Keep debug info in the resulting object file for
- `--unstripped Keep debug info in the resulting object file for`
better debugger interaction. Defaults to off. better debugger interaction. Defaults to off.
--profile Enable vmprof based profiling of time spent. Not
- `--profile Enable vmprof based profiling of time spent. Not`
working currently. Defaults to off. working currently. Defaults to off.
--internal-graph Create graph of optimization process internals, do not
- `--internal-graph Create graph of optimization process internals, do not`
use for whole programs, but only for small test cases. use for whole programs, but only for small test cases.
Defaults to off. Defaults to off.
--trace-execution Traced execution output, output the line of code
- `--trace-execution Traced execution output, output the line of code`
before executing it. Defaults to off. before executing it. Defaults to off.
--recompile-c-only This is not incremental compilation, but for Nuitka
- `--recompile-c-only This is not incremental compilation, but for Nuitka`
development only. Takes existing files and simply development only. Takes existing files and simply
compile them as C again. Allows compiling edited C compile them as C again. Allows compiling edited C
files for quick debugging changes to the generated files for quick debugging changes to the generated
@ -269,137 +324,170 @@ Options:
output, etc, Defaults to off. Depends on compiling output, etc, Defaults to off. Depends on compiling
Python source to determine which files it should look Python source to determine which files it should look
at. at.
--xml=XML_FILENAME Write the internal program structure, result of
- `--xml=XML_FILENAME Write the internal program structure, result of`
optimization in XML form to given filename. optimization in XML form to given filename.
--generate-c-only Generate only C source code, and do not compile it to
- `--generate-c-only Generate only C source code, and do not compile it to`
binary or module. This is for debugging and code binary or module. This is for debugging and code
coverage analysis that doesn't waste CPU. Defaults to coverage analysis that doesn't waste CPU. Defaults to
off. Do not think you can use this directly. off. Do not think you can use this directly.
--experimental=FLAG
- `--experimental=FLAG`
Use features declared as 'experimental'. May have no Use features declared as 'experimental'. May have no
effect if no experimental features are present in the effect if no experimental features are present in the
code. Uses secret tags (check source) per experimented code. Uses secret tags (check source) per experimented
feature. feature.
--low-memory Attempt to use less memory, by forking less C
- `--low-memory Attempt to use less memory, by forking less C`
compilation jobs and using options that use less compilation jobs and using options that use less
memory. For use on embedded machines. Use this in case memory. For use on embedded machines. Use this in case
of out of memory problems. Defaults to off. of out of memory problems. Defaults to off.
Backend C compiler choice: Backend C compiler choice:
--clang Enforce the use of clang. On Windows this requires a
- `--clang Enforce the use of clang. On Windows this requires a`
working Visual Studio version to piggy back on. working Visual Studio version to piggy back on.
Defaults to off. Defaults to off.
--mingw64 Enforce the use of MinGW64 on Windows. Defaults to off
- `--mingw64 Enforce the use of MinGW64 on Windows. Defaults to off`
unless MSYS2 with MinGW Python is used. unless MSYS2 with MinGW Python is used.
--msvc=MSVC_VERSION
- `--msvc=MSVC_VERSION`
Enforce the use of specific MSVC version on Windows. Enforce the use of specific MSVC version on Windows.
Allowed values are e.g. "14.3" (MSVC 2022) and other Allowed values are e.g. "14.3" (MSVC 2022) and other
MSVC version numbers, specify "list" for a list of MSVC version numbers, specify "list" for a list of
installed compilers, or use "latest". Defaults to installed compilers, or use "latest". Defaults to
latest MSVC being used if installed, otherwise MinGW64 latest MSVC being used if installed, otherwise MinGW64
is used. is used.
--jobs=N Specify the allowed number of parallel C compiler
- `--jobs=N Specify the allowed number of parallel C compiler`
jobs. Defaults to the system CPU count. jobs. Defaults to the system CPU count.
--lto=choice Use link time optimizations (MSVC, gcc, clang).
- `--lto=choice Use link time optimizations (MSVC, gcc, clang).`
Allowed values are "yes", "no", and "auto" (when it's Allowed values are "yes", "no", and "auto" (when it's
known to work). Defaults to "auto". known to work). Defaults to "auto".
--static-libpython=choice
- `--static-libpython=choice`
Use static link library of Python. Allowed values are Use static link library of Python. Allowed values are
"yes", "no", and "auto" (when it's known to work). "yes", "no", and "auto" (when it's known to work).
Defaults to "auto". Defaults to "auto".
Cache Control: Cache Control:
--disable-cache=DISABLED_CACHES
- `--disable-cache=DISABLED_CACHES`
Disable selected caches, specify "all" for all cached. Disable selected caches, specify "all" for all cached.
Currently allowed values are: Currently allowed values are:
"all","ccache","bytecode","dll-dependencies". can be "all","ccache","bytecode","dll-dependencies". can be
given multiple times or with comma separated values. given multiple times or with comma separated values.
Default none. Default none.
--clean-cache=CLEAN_CACHES
- `--clean-cache=CLEAN_CACHES`
Clean the given caches before executing, specify "all" Clean the given caches before executing, specify "all"
for all cached. Currently allowed values are: for all cached. Currently allowed values are:
"all","ccache","bytecode","dll-dependencies". can be "all","ccache","bytecode","dll-dependencies". can be
given multiple times or with comma separated values. given multiple times or with comma separated values.
Default none. Default none.
--disable-bytecode-cache
- `--disable-bytecode-cache`
Do not reuse dependency analysis results for modules, Do not reuse dependency analysis results for modules,
esp. from standard library, that are included as esp. from standard library, that are included as
bytecode. Same as --disable-cache=bytecode. bytecode. Same as --disable-cache=bytecode.
--disable-ccache Do not attempt to use ccache (gcc, clang, etc.) or
- `--disable-ccache Do not attempt to use ccache (gcc, clang, etc.) or`
clcache (MSVC, clangcl). Same as --disable- clcache (MSVC, clangcl). Same as --disable-
cache=ccache. cache=ccache.
--disable-dll-dependency-cache
- `--disable-dll-dependency-cache`
Disable the dependency walker cache. Will result in Disable the dependency walker cache. Will result in
much longer times to create the distribution folder, much longer times to create the distribution folder,
but might be used in case the cache is suspect to but might be used in case the cache is suspect to
cause errors. Same as --disable-cache=dll- cause errors. Same as --disable-cache=dll-
dependencies. dependencies.
--force-dll-dependency-cache-update
- `--force-dll-dependency-cache-update`
For an update of the dependency walker cache. Will For an update of the dependency walker cache. Will
result in much longer times to create the distribution result in much longer times to create the distribution
folder, but might be used in case the cache is suspect folder, but might be used in case the cache is suspect
to cause errors or known to need an update. to cause errors or known to need an update.
PGO compilation choices: PGO compilation choices:
--pgo Enables C level profile guided optimization (PGO), by
- `--pgo Enables C level profile guided optimization (PGO), by`
executing a dedicated build first for a profiling run, executing a dedicated build first for a profiling run,
and then using the result to feedback into the C and then using the result to feedback into the C
compilation. Note: This is experimental and not compilation. Note: This is experimental and not
working with standalone modes of Nuitka yet. Defaults working with standalone modes of Nuitka yet. Defaults
to off. to off.
--pgo-args=PGO_ARGS
- `--pgo-args=PGO_ARGS`
Arguments to be passed in case of profile guided Arguments to be passed in case of profile guided
optimization. These are passed to the special built optimization. These are passed to the special built
executable during the PGO profiling run. Default executable during the PGO profiling run. Default
empty. empty.
--pgo-executable=PGO_EXECUTABLE
- `--pgo-executable=PGO_EXECUTABLE`
Command to execute when collecting profile Command to execute when collecting profile
information. Use this only, if you need to launch it information. Use this only, if you need to launch it
through a script that prepares it to run. Default use through a script that prepares it to run. Default use
created program. created program.
Tracing features: Tracing features:
--report=REPORT_FILENAME
- `--report=REPORT_FILENAME`
Report module, data files, compilation, plugin, etc. Report module, data files, compilation, plugin, etc.
details in an XML output file. This is also super details in an XML output file. This is also super
useful for issue reporting. Default is off. useful for issue reporting. Default is off.
--quiet Disable all information outputs, but show warnings.
- `--quiet Disable all information outputs, but show warnings.`
Defaults to off. Defaults to off.
--show-scons Run the C building backend Scons with verbose
- `--show-scons Run the C building backend Scons with verbose`
information, showing the executed commands, detected information, showing the executed commands, detected
compilers. Defaults to off. compilers. Defaults to off.
--no-progressbar Disable progress bars. Defaults to off.
--show-progress Obsolete: Provide progress information and statistics. - `--no-progressbar Disable progress bars. Defaults to off.`
- `--show-progress Obsolete: Provide progress information and statistics.`
Disables normal progress bar. Defaults to off. Disables normal progress bar. Defaults to off.
--show-memory Provide memory information and statistics. Defaults to
- `--show-memory Provide memory information and statistics. Defaults to`
off. off.
--show-modules Provide information for included modules and DLLs
- `--show-modules Provide information for included modules and DLLs`
Obsolete: You should use '--report' file instead. Obsolete: You should use '--report' file instead.
Defaults to off. Defaults to off.
--show-modules-output=PATH
- `--show-modules-output=PATH`
Where to output '--show-modules', should be a Where to output '--show-modules', should be a
filename. Default is standard output. filename. Default is standard output.
--verbose Output details of actions taken, esp. in
- `--verbose Output details of actions taken, esp. in`
optimizations. Can become a lot. Defaults to off. optimizations. Can become a lot. Defaults to off.
--verbose-output=PATH
- `--verbose-output=PATH`
Where to output from '--verbose', should be a Where to output from '--verbose', should be a
filename. Default is standard output. filename. Default is standard output.
General OS controls: General OS controls:
--disable-console When compiling for Windows or macOS, disable the
- `--disable-console When compiling for Windows or macOS, disable the`
console window and create a GUI application. Defaults console window and create a GUI application. Defaults
to off. to off.
--enable-console When compiling for Windows or macOS, enable the
- `--enable-console When compiling for Windows or macOS, enable the`
console window and create a console application. This console window and create a console application. This
disables hints from certain modules, e.g. "PySide" disables hints from certain modules, e.g. "PySide"
that suggest to disable it. Defaults to true. that suggest to disable it. Defaults to true.
--force-stdout-spec=FORCE_STDOUT_SPEC
- `--force-stdout-spec=FORCE_STDOUT_SPEC`
Force standard output of the program to go to this Force standard output of the program to go to this
location. Useful for programs with disabled console location. Useful for programs with disabled console
and programs using the Windows Services Plugin of and programs using the Windows Services Plugin of
Nuitka commercial. Defaults to not active, use e.g. Nuitka commercial. Defaults to not active, use e.g.
'%PROGRAM%.out.txt', i.e. file near your program. '%PROGRAM%.out.txt', i.e. file near your program.
--force-stderr-spec=FORCE_STDERR_SPEC
- `--force-stderr-spec=FORCE_STDERR_SPEC`
Force standard error of the program to go to this Force standard error of the program to go to this
location. Useful for programs with disabled console location. Useful for programs with disabled console
and programs using the Windows Services Plugin of and programs using the Windows Services Plugin of
@ -407,51 +495,62 @@ Options:
'%PROGRAM%.err.txt', i.e. file near your program. '%PROGRAM%.err.txt', i.e. file near your program.
Windows specific controls: Windows specific controls:
--windows-icon-from-ico=ICON_PATH
- `--windows-icon-from-ico=ICON_PATH`
Add executable icon. Can be given multiple times for Add executable icon. Can be given multiple times for
different resolutions or files with multiple icons different resolutions or files with multiple icons
inside. In the later case, you may also suffix with inside. In the later case, you may also suffix with
#<n> where n is an integer index starting from 1, #<n> where n is an integer index starting from 1,
specifying a specific icon to be included, and all specifying a specific icon to be included, and all
others to be ignored. others to be ignored.
--windows-icon-from-exe=ICON_EXE_PATH
- `--windows-icon-from-exe=ICON_EXE_PATH`
Copy executable icons from this existing executable Copy executable icons from this existing executable
(Windows only). (Windows only).
--onefile-windows-splash-screen-image=SPLASH_SCREEN_IMAGE
- `--onefile-windows-splash-screen-image=SPLASH_SCREEN_IMAGE`
When compiling for Windows and onefile, show this When compiling for Windows and onefile, show this
while loading the application. Defaults to off. while loading the application. Defaults to off.
--windows-uac-admin
- `--windows-uac-admin`
Request Windows User Control, to grant admin rights on Request Windows User Control, to grant admin rights on
execution. (Windows only). Defaults to off. execution. (Windows only). Defaults to off.
--windows-uac-uiaccess
- `--windows-uac-uiaccess`
Request Windows User Control, to enforce running from Request Windows User Control, to enforce running from
a few folders only, remote desktop access. (Windows a few folders only, remote desktop access. (Windows
only). Defaults to off. only). Defaults to off.
macOS specific controls: macOS specific controls:
--macos-target-arch=MACOS_TARGET_ARCH
- `--macos-target-arch=MACOS_TARGET_ARCH`
What architectures is this to supposed to run on. What architectures is this to supposed to run on.
Default and limit is what the running Python allows Default and limit is what the running Python allows
for. Default is "native" which is the architecture the for. Default is "native" which is the architecture the
Python is run with. Python is run with.
--macos-create-app-bundle
- `--macos-create-app-bundle`
When compiling for macOS, create a bundle rather than When compiling for macOS, create a bundle rather than
a plain binary application. Currently experimental and a plain binary application. Currently experimental and
incomplete. Currently this is the only way to unlock incomplete. Currently this is the only way to unlock
disabling of console.Defaults to off. disabling of console.Defaults to off.
--macos-app-icon=ICON_PATH
- `--macos-app-icon=ICON_PATH`
Add icon for the application bundle to use. Can be Add icon for the application bundle to use. Can be
given only one time. Defaults to Python icon if given only one time. Defaults to Python icon if
available. available.
--macos-signed-app-name=MACOS_SIGNED_APP_NAME
- `--macos-signed-app-name=MACOS_SIGNED_APP_NAME`
Name of the application to use for macOS signing. Name of the application to use for macOS signing.
Follow "com.YourCompany.AppName" naming results for Follow "com.YourCompany.AppName" naming results for
best results, as these have to be globally unique, and best results, as these have to be globally unique, and
will potentially grant protected API accesses. will potentially grant protected API accesses.
--macos-app-name=MACOS_APP_NAME
- `--macos-app-name=MACOS_APP_NAME`
Name of the product to use in macOS bundle Name of the product to use in macOS bundle
information. Defaults to base filename of the binary. information. Defaults to base filename of the binary.
--macos-app-mode=MODE
- `--macos-app-mode=MODE`
Mode of application for the application bundle. When Mode of application for the application bundle. When
launching a Window, and appearing in Docker is launching a Window, and appearing in Docker is
desired, default value "gui" is a good fit. Without a desired, default value "gui" is a good fit. Without a
@ -460,20 +559,24 @@ Options:
later, "ui-element" is in-between. The application later, "ui-element" is in-between. The application
will not appear in dock, but get full access to will not appear in dock, but get full access to
desktop when it does open a Window later. desktop when it does open a Window later.
--macos-sign-identity=MACOS_APP_VERSION
- `--macos-sign-identity=MACOS_APP_VERSION`
When signing on macOS, by default an ad-hoc identify When signing on macOS, by default an ad-hoc identify
will be used, but with this option your get to specify will be used, but with this option your get to specify
another identity to use. The signing of code is now another identity to use. The signing of code is now
mandatory on macOS and cannot be disabled. Default mandatory on macOS and cannot be disabled. Default
"ad-hoc" if not given. "ad-hoc" if not given.
--macos-sign-notarization
- `--macos-sign-notarization`
When signing for notarization, using a proper TeamID When signing for notarization, using a proper TeamID
identity from Apple, use the required runtime signing identity from Apple, use the required runtime signing
option, such that it can be accepted. option, such that it can be accepted.
--macos-app-version=MACOS_APP_VERSION
- `--macos-app-version=MACOS_APP_VERSION`
Product version to use in macOS bundle information. Product version to use in macOS bundle information.
Defaults to "1.0" if not given. Defaults to "1.0" if not given.
--macos-app-protected-resource=RESOURCE_DESC
- `--macos-app-protected-resource=RESOURCE_DESC`
Request an entitlement for access to a macOS protected Request an entitlement for access to a macOS protected
resources, e.g. resources, e.g.
"NSMicrophoneUsageDescription:Microphone access for "NSMicrophoneUsageDescription:Microphone access for
@ -487,47 +590,58 @@ Options:
multiple times. Default empty. multiple times. Default empty.
Linux specific controls: Linux specific controls:
--linux-icon=ICON_PATH
- `--linux-icon=ICON_PATH`
Add executable icon for onefile binary to use. Can be Add executable icon for onefile binary to use. Can be
given only one time. Defaults to Python icon if given only one time. Defaults to Python icon if
available. available.
Binary Version Information: Binary Version Information:
--company-name=COMPANY_NAME
- `--company-name=COMPANY_NAME`
Name of the company to use in version information. Name of the company to use in version information.
Defaults to unused. Defaults to unused.
--product-name=PRODUCT_NAME
- `--product-name=PRODUCT_NAME`
Name of the product to use in version information. Name of the product to use in version information.
Defaults to base filename of the binary. Defaults to base filename of the binary.
--file-version=FILE_VERSION
- `--file-version=FILE_VERSION`
File version to use in version information. Must be a File version to use in version information. Must be a
sequence of up to 4 numbers, e.g. 1.0 or 1.0.0.0, no sequence of up to 4 numbers, e.g. 1.0 or 1.0.0.0, no
more digits are allowed, no strings are allowed. more digits are allowed, no strings are allowed.
Defaults to unused. Defaults to unused.
--product-version=PRODUCT_VERSION
- `--product-version=PRODUCT_VERSION`
Product version to use in version information. Same Product version to use in version information. Same
rules as for file version. Defaults to unused. rules as for file version. Defaults to unused.
--file-description=FILE_DESCRIPTION
- `--file-description=FILE_DESCRIPTION`
Description of the file used in version information. Description of the file used in version information.
Windows only at this time. Defaults to binary Windows only at this time. Defaults to binary
filename. filename.
--copyright=COPYRIGHT_TEXT
- `--copyright=COPYRIGHT_TEXT`
Copyright used in version information. Windows only at Copyright used in version information. Windows only at
this time. Defaults to not present. this time. Defaults to not present.
--trademarks=TRADEMARK_TEXT
- `--trademarks=TRADEMARK_TEXT`
Copyright used in version information. Windows only at Copyright used in version information. Windows only at
this time. Defaults to not present. this time. Defaults to not present.
Plugin control: Plugin control:
--enable-plugin=PLUGIN_NAME
- `--enable-plugin=PLUGIN_NAME`
Enabled plugins. Must be plug-in names. Use '--plugin- Enabled plugins. Must be plug-in names. Use '--plugin-
list' to query the full list and exit. Default empty. list' to query the full list and exit. Default empty.
--disable-plugin=PLUGIN_NAME
- `--disable-plugin=PLUGIN_NAME`
Disabled plugins. Must be plug-in names. Use '-- Disabled plugins. Must be plug-in names. Use '--
plugin-list' to query the full list and exit. Most plugin-list' to query the full list and exit. Most
standard plugins are not a good idea to disable. standard plugins are not a good idea to disable.
Default empty. Default empty.
--plugin-no-detection
- `--plugin-no-detection`
Plugins can detect if they might be used, and the you Plugins can detect if they might be used, and the you
can disable the warning via "--disable-plugin=plugin- can disable the warning via "--disable-plugin=plugin-
that-warned", or you can use this option to disable that-warned", or you can use this option to disable
@ -535,50 +649,61 @@ Options:
compilation slightly of course as this detection code compilation slightly of course as this detection code
is run in vain once you are certain of which plugins is run in vain once you are certain of which plugins
to use. Defaults to off. to use. Defaults to off.
--plugin-list Show list of all available plugins and exit. Defaults
- `--plugin-list Show list of all available plugins and exit. Defaults`
to off. to off.
--user-plugin=PATH The file name of user plugin. Can be given multiple
- `--user-plugin=PATH The file name of user plugin. Can be given multiple`
times. Default empty. times. Default empty.
--show-source-changes
- `--show-source-changes`
Show source changes to original Python file content Show source changes to original Python file content
before compilation. Mostly intended for developing before compilation. Mostly intended for developing
plugins. Default False. plugins. Default False.
Plugin options of 'anti-bloat': Plugin options of 'anti-bloat':
--show-anti-bloat-changes
- `--show-anti-bloat-changes`
Annotate what changes are by the plugin done. Annotate what changes are by the plugin done.
--noinclude-setuptools-mode=NOINCLUDE_SETUPTOOLS_MODE
- `--noinclude-setuptools-mode=NOINCLUDE_SETUPTOOLS_MODE`
What to do if a 'setuptools' or import is encountered. What to do if a 'setuptools' or import is encountered.
This package can be big with dependencies, and should This package can be big with dependencies, and should
definitely be avoided. Also handles 'setuptools_scm'. definitely be avoided. Also handles 'setuptools_scm'.
--noinclude-pytest-mode=NOINCLUDE_PYTEST_MODE
- `--noinclude-pytest-mode=NOINCLUDE_PYTEST_MODE`
What to do if a 'pytest' import is encountered. This What to do if a 'pytest' import is encountered. This
package can be big with dependencies, and should package can be big with dependencies, and should
definitely be avoided. Also handles 'nose' imports. definitely be avoided. Also handles 'nose' imports.
--noinclude-unittest-mode=NOINCLUDE_UNITTEST_MODE
- `--noinclude-unittest-mode=NOINCLUDE_UNITTEST_MODE`
What to do if a unittest import is encountered. This What to do if a unittest import is encountered. This
package can be big with dependencies, and should package can be big with dependencies, and should
definitely be avoided. definitely be avoided.
--noinclude-IPython-mode=NOINCLUDE_IPYTHON_MODE
- `--noinclude-IPython-mode=NOINCLUDE_IPYTHON_MODE`
What to do if a IPython import is encountered. This What to do if a IPython import is encountered. This
package can be big with dependencies, and should package can be big with dependencies, and should
definitely be avoided. definitely be avoided.
--noinclude-dask-mode=NOINCLUDE_DASK_MODE
- `--noinclude-dask-mode=NOINCLUDE_DASK_MODE`
What to do if a 'dask' import is encountered. This What to do if a 'dask' import is encountered. This
package can be big with dependencies, and should package can be big with dependencies, and should
definitely be avoided. definitely be avoided.
--noinclude-numba-mode=NOINCLUDE_NUMBA_MODE
- `--noinclude-numba-mode=NOINCLUDE_NUMBA_MODE`
What to do if a 'numba' import is encountered. This What to do if a 'numba' import is encountered. This
package can be big with dependencies, and is currently package can be big with dependencies, and is currently
not working for standalone. This package is big with not working for standalone. This package is big with
dependencies, and should definitely be avoided. dependencies, and should definitely be avoided.
--noinclude-default-mode=NOINCLUDE_DEFAULT_MODE
- `--noinclude-default-mode=NOINCLUDE_DEFAULT_MODE`
This actually provides the default "warning" value for This actually provides the default "warning" value for
above options, and can be used to turn all of these above options, and can be used to turn all of these
on. on.
--noinclude-custom-mode=CUSTOM_CHOICES
- `--noinclude-custom-mode=CUSTOM_CHOICES`
What to do if a specific import is encountered. Format What to do if a specific import is encountered. Format
is module name, which can and should be a top level is module name, which can and should be a top level
package and then one choice, "error", "warning", package and then one choice, "error", "warning",
"nofollow", e.g. PyQt5:error. "nofollow", e.g. PyQt5:error.
```

2
docs/src/rua!.md
View File

@ -16,5 +16,5 @@ pyglet 坐标轴原点是左上角
# 素材提供 # 素材提供
[背景候选1号](background.png) [背景候选1号](../../textures/runtime/background.png)
来自 @底层萌新 QQ：1744251171 来自 @底层萌新 QQ：1744251171

2
docs/src/update_logs.md
View File

@ -12,7 +12,7 @@
- [![Readme-github](https://img.shields.io/badge/Readme-Github-blue.svg?style=flat-square&logo=Github)](https://github.com/shenjackyuanjie/Difficult-Rocket) - [![Readme-github](https://img.shields.io/badge/Readme-Github-blue.svg?style=flat-square&logo=Github)](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [![Readme-gitee](https://img.shields.io/badge/Readme-Gitee-blue.svg?style=flat-square&logo=Gitee)](https://gitee.com/shenjackyuanjie/Difficult-Rocket) - [![Readme-gitee](https://img.shields.io/badge/Readme-Gitee-blue.svg?style=flat-square&logo=Gitee)](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
- [![Readme-gitee](https://img.shields.io/badge/Readme-中文(点我!)-blue.svg?style=flat-square)](../README.md) - [![Readme-gitee](https://img.shields.io/badge/Readme-中文(点我!)-blue.svg?style=flat-square)](../../README.md)
- Using [SemVer 2.0.0](https://semver.org/) to manage version - Using [SemVer 2.0.0](https://semver.org/) to manage version
## 20221124 V 0.6.4 ## 20221124 V 0.6.4