How to Remove/Exclude Modules And Files From Pyinstaller?

7 minutes read

To remove or exclude modules and files from PyInstaller, you can use the "--exclude-module" and "--exclude" options when running PyInstaller from the command line. These options allow you to specify which modules or files you want to exclude from the final packaged executable.


For example, to exclude a specific module, you can use the "--exclude-module" option followed by the module name. This will prevent PyInstaller from including that module in the final executable.


Similarly, to exclude specific files or directories, you can use the "--exclude" option followed by the file or directory path. This will ensure that those files are not included in the packaged executable.


By using these options, you can customize the contents of your final executable and reduce its size by excluding unnecessary modules and files.

Best Python Books of December 2024

1
Learning Python, 5th Edition

Rating is 5 out of 5

Learning Python, 5th Edition

2
Head First Python: A Brain-Friendly Guide

Rating is 4.9 out of 5

Head First Python: A Brain-Friendly Guide

3
Python for Beginners: 2 Books in 1: Python Programming for Beginners, Python Workbook

Rating is 4.8 out of 5

Python for Beginners: 2 Books in 1: Python Programming for Beginners, Python Workbook

4
Python All-in-One For Dummies (For Dummies (Computer/Tech))

Rating is 4.7 out of 5

Python All-in-One For Dummies (For Dummies (Computer/Tech))

5
Python for Everybody: Exploring Data in Python 3

Rating is 4.6 out of 5

Python for Everybody: Exploring Data in Python 3

6
Learn Python Programming: The no-nonsense, beginner's guide to programming, data science, and web development with Python 3.7, 2nd Edition

Rating is 4.5 out of 5

Learn Python Programming: The no-nonsense, beginner's guide to programming, data science, and web development with Python 3.7, 2nd Edition

7
Python Machine Learning: Machine Learning and Deep Learning with Python, scikit-learn, and TensorFlow 2, 3rd Edition

Rating is 4.4 out of 5

Python Machine Learning: Machine Learning and Deep Learning with Python, scikit-learn, and TensorFlow 2, 3rd Edition


How to exclude a package from PyInstaller build?

To exclude a package from a PyInstaller build, you can use the --exclude-module option when running PyInstaller. Follow these steps to exclude a package:

  1. Open a command prompt or terminal window.
  2. Run PyInstaller with the --exclude-module option followed by the package name you want to exclude. For example:
1
pyinstaller --exclude-module package_name script.py


Replace package_name with the name of the package you want to exclude and script.py with the name of the script you want to build.

  1. PyInstaller will build the executable excluding the specified package.


Note: If the package you want to exclude is a third-party package, make sure to exclude all modules belonging to that package. You can list multiple packages to exclude by separating them with a comma:

1
pyinstaller --exclude-module package1,package2 script.py



What is the command line argument for excluding files in PyInstaller?

To exclude files in PyInstaller, you can use the --exclude-module command line argument followed by the modules you want to exclude. For example:

1
pyinstaller --exclude-module numpy your_script.py


This command will exclude the numpy module from being included in the generated executable. You can also specify multiple modules to exclude by separating them with a comma:

1
pyinstaller --exclude-module numpy,pandas your_script.py


This will exclude both the numpy and pandas modules from the executable.


How to remove certain modules from PyInstaller bundle?

To remove certain modules from a PyInstaller bundle, you can use the --exclude-module flag when running PyInstaller. Here's how you can do it:

  1. Open your terminal or command prompt.
  2. Navigate to the directory where your Python script is located.
  3. Run the following command to create a PyInstaller bundle while excluding the modules you want to remove:
1
pyinstaller --onefile --exclude-module modulename yourscript.py


Replace modulename with the name of the module you want to exclude and yourscript.py with the name of your Python script.

  1. PyInstaller will create a bundled executable with the specified module excluded.


Please note that some modules may be required by other modules in your script, so removing certain modules may cause your script to not run properly. Be sure to test your bundled executable thoroughly after making any changes.

Facebook Twitter LinkedIn Telegram Whatsapp Pocket

Related Posts:

To run unit tests using pyinstaller, you first need to install pyinstaller by running pip install pyinstaller in your terminal. Once pyinstaller is installed, you can use the command pyinstaller --onefile your_script.py to create a standalone executable file f...
When using PyInstaller to package a project that utilizes TextBlob, additional steps may be necessary to ensure that the necessary files and modules for TextBlob are included in the packaged executable. One way to achieve this is by adding a "hook" for...
To include PyTorch in a PyInstaller app, you first need to make sure that PyInstaller is installed on your system. PyInstaller is a tool used to package Python applications into standalone executables.Once you have PyInstaller installed, you can include PyTorc...