Miserlou/Zappa

Allow user to exclude packages from .py trimming

Open

#635 opened on Jan 30, 2017

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (11,903 stars) (1,286 forks)batch import
help wanted

Description

Context

Zappa excludes .py files as it packages up Python directories if a .pyc/.pyo exists. However some tools need to find the .py file, in my case Pyramid's plugin extension locator.

Expected Behavior

The zipped package should have .py files if needed as some Python packages expect to find them.

Actual Behavior

All .py files are removed.

Possible Fix

Provide a zappa settings option to specify packages that should be excluded from this process.

Steps to Reproduce

  1. Package up anything that has .pyc files
  2. Look at the resulting zip that has no .py files.

Contributor guide

Tech stack
python
Domain
toolingdevopscloud
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingFamiliarity with Zappa
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine Zappa's packaging code (likely in a module like `package.py`) to understand how .py files are trimmed. Look for the logic that removes .py files when .pyc exists. Add a new configuration option, e.g., `exclude from py trimming`, that accepts a list of package names to skip during trimming. Ensure the option is documented and integrated into the settings parsing. Test with a simple Pyramid project to confirm .py files are preserved for specified packages.