Python Inliner merges in a single file all files from a Python package.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
pinliner
tests
.editorconfig
.gitignore
.travis.yml
AUTHORS.rst
CONTRIBUTING.rst
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.rst
requirements_dev.txt
setup.cfg
setup.py
tox.ini
travis_pypi_setup.py

README.rst

pinliner - Python Inliner

This tool allows you to merge all files that comprise a Python package into a single file and be able to use this single file as if it were a package.

Not only will it behave as if it were the original package, but it will also show code in exceptions and debug sessions, and will display the right line number and file when logging.

Imports will work as usual so if you have a package structure like:

.
└── [my_package]
     ├── file_a.py
     ├── [sub_package]
     │    ├── file_b.py
     │    └── __init__.py
     ├── __init__.py

And with pinliner installed you execute:

$ mkdir inlined
$ pinliner my_package -o inlined/my_package.py
$ cd inlined
$ python

You'll be able to use generated my_package.py file as if it were the real package:

>>> import my_package
>>> from my_package import file_a as a_file
>>> from my_package.sub_package import file_b

And __init__.py contents will be executed as expected when importing my_package package and you'll be able to access its contents like you would with your normal package.

Modules will also behave as usual.

If your package is checking __name__ for __main__ it will also work as usual. Although given the fact that we only have 1 file we will no longer be able to call other packages/modules directly from the command line to trigger code conditioned to __name__ having __main__ as its value.

Loader code will automatically compile packages and modules to byte code, before running it. When a module is imported for the first time, or when the specific's package/module source (not the whole inlined file) is more recent than the current compiled file, a .pyc file containing the compiled code will be created in the same directory as the pinlined .py file.

If the byte code is up to date then it will be used instead, thus avoiding a recompilation, exactly the same as python normally does, with the only exception that all .pyc files will be in the same directory and the filenames will include the full path to the original file.

Bundle

Pinliner is now capable of acting like a bundle where multiple packages can be inlined into a single file.

When including multiple files the default is not to automatically load any of the packages from the module when loading the bundle.

$ pinliner my_package another_package -o bundle.py
$ python
>>> import bundle

>>> import my_package
>>> from my_package import file_a as a_file
>>> from my_package.sub_package import file_b

>>> import another_package

We can default to automatically load a specific package from the bundle:

$ pinliner my_package another_package -d another_package -o another_package.py

This is convenient if we include multiple packages but we have a main program that we want to execute automatically and the others are just libraries required by this probram.

Inlined file name

For inlined package and bundles to work as expected one must pay attention to the inlined file name following these rules:

  • Output filename of an inlined single package must have the same name as the package itself: $ pinliner my_package -o inlined/my_package.py
  • Output filename of a bundle with no default package must not match ANY of the packages included in the bundle: $ pinliner my_package another_package -o bundle.py
  • Output filename of a bundle with a default package must match the default package name: $ pinliner my_package another_package -d another_package -o another_package.py
  • Output filename of a single package with an empty default must have a name that doesn't match the inlined package name: $ pinliner my_package -d '' -o inlined.py

Installation

You can install pinliner globally in your system or use a virtual environment, this is how it could be done using a virtual environment:

$ virtualenv .venv
$ source .venv/bin/activate
$ pip install pinliner

After that you can run the tool with pinliner.