Package is accidentally shipping its tests

Open Beginner friendly
#475 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
build-system

Research direction

Start by inspecting the package exclusion configuration in setup.py, especially the existing tests entry. Build or install the package and run pip show --files azure-functions-durable to verify the result. Done means the installed package no longer includes the top-level tests package or its test files.

Written by the indexing model from the issue text.

Description

bug fixed-in-v2 P3

🐛 Describe the bug

It looks like this package is accidentally shipping its tests. This can be easily verified with:

pip show --files azure-functions-durable

Which shows that there are 76 tests files shipped by the package into a top-level package called tests. This has a few small issues:

  • It bloats the package size.
  • It leads to collisions with other packages that accidentally ship their tests as tests module (they just overwrite each other in the site-packages directory).
  • It can lead to issues for users if it conflicts with their tests package.

🤔 Expected behavior

The shipped package should not include its tests.

Possible cause / solution

It looks like the setup.py already lists tests under exclude:

https://github.com/Azure/azure-functions-durable-python/blob/b30d0a64f7b8c1042f066006af57b74976cdf9d2/setup.py#L29-L34

However if I remember correctly the pattern should be tests/* or tests* or tests.* or so to really affect subfolders. Otherwise the listing of azure itself would lead to the exclusion of the whole code (in this case it is most likely just about the exclusion of the top-level __init__.py).

☕ Steps to reproduce

pip install azure-functions-durable
pip show --files azure-functions-durable
Dominant language
Python
Stars
157
Forks
70
Avg merge
2d 10h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/azure-functions-durable-python

All issues in Azure/azure-functions-durable-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.