David,
My pleasure. More edits below.
Bryan
@@ -924,11 +924,11 @@ The statements do the following:
* A new instance of class ``Analysis`` takes a list of script names as
input.
The resulting object (here named ``a``) contains three lists,
- held in object properties named:
+ held in object properties named
- - ``scripts``: the python scripts named on the command line
- - ``pure``: pure python modules needed by the scripts
- - ``binaries``: non-python modules needed by the scripts
+ - ``scripts``: the python scripts named on the command line;
+ - ``pure``: pure python modules needed by the scripts;
+ - ``binaries``: non-python modules needed by the scripts.
* An instance of ``PYZ`` (a ``.pyz`` archive, described
under `Inspecting Archives`_ below) is built to contain the modules
@@ -962,7 +962,7 @@ the ``pure`` member is a TOC with a list of modules,
and so on.
Basically a ``TOC`` object contains a list of tuples of the form
- ``(`` *name* ``,`` *path* ``,`` *typecode* ``)``
+ ``(``\ *name*\ ``,``\ *path*\ ``,``\ *typecode*\ ``)``
In fact, it acts as an ordered set of tuples; that is, it contains no
duplicates
(where uniqueness is based on the *name* element of each tuple).
@@ -979,7 +979,7 @@ For example,
is an expression that yields a TOC from which any tuple named ``badmodule``
has been removed.
-The right-hand argument is a list that contains one tuple
+Note that the right-hand argument to the subtraction operator is a list
that contains one tuple
in which *name* is ``badmodule`` and the *path* and *typecode* elements
are ``None``.
(Because set membership is based on the *name* element of a tuple only,
@@ -1017,7 +1017,7 @@ The Tree Class
The Tree class is a way of creating a TOC that describes some or all of the
files within a directory:
- ``Tree(`` *root* ``, prefix=`` *run-time-folder* ``, excludes=``
*match* ``)``
+ ``Tree(``\ *root*\ ``, prefix=``\ *run-time-folder*\ ``,
excludes=``\ *match*\ ``)``
* The *root* argument is a path string to a directory.
It may be absolute or relative to the build directory.
@@ -1032,9 +1032,9 @@ files within a directory:
strings that match files in the *root* that should be omitted from the
Tree.
An item in the list can be either:
- - a name, and files or folders with this basename are excluded
+ - a name, which causes files or folders with this basename to be
excluded;
- - ``*.ext`` and files with this extension are excluded
+ - ``*.ext``, which causes files with this extension to be excluded.
For example::
@@ -1059,7 +1059,7 @@ To add a README file at the top level of a one-folder
bundle::
[('README', '/my/project/readme', 'DATA')], ...)
This adds one tuple to the ``a.binaries`` TOC.
-However, COLLECT class takes a variable-length list of arguments,
+However, the COLLECT class takes a variable-length list of arguments,
so it is possible to just append a list of one tuple to the argument list::
collect = COLLECT(a.binaries,
@@ -1136,7 +1136,7 @@ Getting the Latest Version
If you have some reason to think you have found a bug in |PyInstaller|
you can try downloading the latest development version.
-This version might have fixes or features that are not yet at ``pypi``.
+This version might have fixes or features that are not yet at ``PyPI``.
Links to download the latest stable version and the latest development
version are at PyInstaller.org_.
@@ -1250,7 +1250,7 @@ Users would find the messages annoying.
Getting Python's Verbose Imports
--------------------------------
-You can also pass a ``-v`` (verbose imports) flag to the embedded Python
+You can also pass a ``-v`` (verbose imports) flag to the embedded Python
interpreter
(see `Giving Run-time Python Options`_ above).
This can be extremely useful.
It can be informative even with apps that are apparently working,
@@ -1300,7 +1300,7 @@ set the ``-v`` flag (`Getting Python's Verbose
Imports`_ above).
Once you know what they are, you add the needed modules
to the bundle using the ``--hidden-import=`` command option,
by editing the spec file, or
-with a hook file: `Using Hook Files`_ below.
+with a hook file (see `Using Hook Files`_ below).
Extending a Package's ``__path__``
----------------------------------
@@ -1326,7 +1326,7 @@ That is, at runtime ``win32com.shell`` is resolved
the same
way as ``win32com.anythingelse``, and ``win32com.__path__``
knows nothing of ``../win32comext``.
-Once in awhile, that's not enough.
+Once in a while, that's not enough.
Changing Runtime Behavior
-------------------------
@@ -1336,10 +1336,10 @@ These are small scripts that manipulate the
environment before your main script
effectively providing additional top-level code to your script.
There are two ways of providing runtime hooks.
-You can name them with the option ``--runtime-hook=`` *path-to-script*.
+You can name them with the option ``--runtime-hook=``\ *path-to-script*.
Second, some runtime hooks are provided.
-At the end of an analysis, the names in the module list are looked up in
+At the end of an analysis, the names in the module list produced by the
analysis phase are looked up in
``loader/rthooks.dat`` in the |PyInstaller| install folder.
This text file is the string representation of a
Python dictionary. The key is the module name, and the value is a list
@@ -1352,13 +1352,13 @@ in the order given, and before any installed
runtime hooks.
If you specify ``--runtime-hook=file1.py --runtime-hook=file2.py``
then the execution order at runtime will be:
-1. Code of ``file1.py``
-2. Code of ``file2.py``
+1. Code of ``file1.py``.
+2. Code of ``file2.py``.
3. Any hook specified for an included module that is found
- in ``rthooks/rthooks.dat``
-4. Your main script
+ in ``rthooks/rthooks.dat``.
+4. Your main script.
-Hooks done in this way, while they need to be careful of what they import,
+Hooks incorporated in this way, while they need to be careful of what they
import,
are free to do almost anything.
One reason to write a run-time hook is to
override some functions or variables from some modules.
@@ -1405,10 +1405,10 @@ as two processes in your system task manager.
What happens during execution of bootloader:
-A. First process: bootloader starts
+A. First process: bootloader starts.
1. If one-file mode, extract bundled files to
- temppath/_MEIxxxxxx
+ ``temppath/_MEIxxxxxx``.
2. Set/unset various environment variables,
e.g. override LD_LIBRARY_PATH on Linux or LIBPATH on AIX;
@@ -1420,19 +1420,19 @@ A. First process: bootloader starts
5. Wait for the child process to finish.
- 6. If one-file mode, delete temppath/_MEIxxxxxx.
+ 6. If one-file mode, delete ``temppath/_MEIxxxxxx``.
B. Second process: bootloader itself started as a child process.
- 1. On Windows set the `activation context`_
+ 1. On Windows set the `activation context`_.
2. Load the Python dynamic library.
The name of the dynamic library is embedded in the
executable file.
- 3. Initialize Python interpreter: set PYTHONPATH, PYTHONHOME
+ 3. Initialize Python interpreter: set PYTHONPATH, PYTHONHOME.
- 4. Run python code.
+ 4. Run the Python code.
Running Python code
@@ -1464,9 +1464,9 @@ Running Python code consists of several steps:
Python imports in a frozen app
-------------------------------------
-PyInstaller embeds compiled python code
+|PyInstaller| embeds compiled python code
(``.pyc`` files) within the executable.
-PyInstaller injects its code into the
+|PyInstaller| injects its code into the
normal Python import mechanism.
Python allows this;
the support is described in `PEP 302`_ "New Import Hooks".
@@ -1498,8 +1498,8 @@ in a bundled app:
3. Is it a C-extension?
The app will try to find a file with name
- *package.subpackage.module* ``.pyd`` or
- *package.subpackage.module* ``.so``
+ *package.subpackage.module*\ ``.pyd`` or
+ *package.subpackage.module*\ ``.so``
4. Next examine paths in the ``sys.path``
(PYTHONPATH).
@@ -1528,10 +1528,10 @@ you get the path to the file with the following
code::
import os
...
if getattr(sys, 'frozen', False):
- # we are running in a pyinstaller bundle
+ # we are running in a PyInstaller bundle
basedir = sys._MEIPASS
else:
- # we are running in a normal python environment
+ # we are running in a normal Python environment
basedir = os.path.dirname(__file__)
The |PyInstaller| |bootloader| adds the attribute ``frozen`` to the
``sys`` module.
@@ -1601,7 +1601,7 @@ Or the text file can be given with a
``--version-file=``
option to ``pyinstaller`` or ``pyi-makespec``.
This approach is used because version resources are strange beasts,
-and it may be impossible to fully understanding them.
+and it may be impossible to fully understand them.
Some elements are optional, others required.
When you view the version tab of a Properties dialog,
there's no straightforward relationship between
@@ -1618,7 +1618,7 @@ for example a ``.tar`` file, a ``.jar`` file, or a
``.zip`` file.
Two kinds of archives are used in |PyInstaller|.
One is a ZlibArchive, which
allows Python modules to be stored efficiently and,
-(with some import hooks) imported directly.
+with some import hooks, imported directly.
The other, a CArchive, is similar to a ``.zip`` file,
a general way of packing up (and optionally compressing) arbitrary blobs
of data.
It gets its name from the fact that it can be manipulated easily from C
On Tue, May 7, 2013 at 10:30 AM, David Cortesi <[email protected]>wrote:
>
>
> "Bryan A. Jones" <[email protected]> May 06 02:58PM -0500
>
>>
>> I did a partial edit of the manual as given on your github site. My
>> diffs
>> are below. Is this readable / helpful?
>>
>> Thank you! I will put these changes in and issue a pull request shortly.
>
>
> --
> You received this message because you are subscribed to the Google Groups
> "PyInstaller" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To post to this group, send email to [email protected].
> Visit this group at http://groups.google.com/group/pyinstaller?hl=en.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>
>
--
Bryan A. Jones, Ph.D.
Associate Professor
Department of Electrical and Computer Engineering
231 Simrall / PO Box 9571
Mississippi State University
Mississippi state, MS 39762
http://www.ece.msstate.edu/~bjones
bjones AT ece DOT msstate DOT edu
voice 662-325-3149
fax 662-325-2298
Our Master, Jesus Christ, is on his way. He'll show up right on
time, his arrival guaranteed by the Blessed and Undisputed Ruler,
High King, High God.
- 1 Tim. 6:14b-15 (The Message)
--
You received this message because you are subscribed to the Google Groups
"PyInstaller" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pyinstaller?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
