tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki Activity

setup.py: which "Twisted" distribution name should we depend on? #378

New issue
Closed
opened 2008-04-10 18:57:25 +00:00 by warner · 5 comments
warner commented 2008-04-10 18:57:25 +00:00
Owner
Copy link

We've learned a bit today about the overzealous downloading/installation of
Twisted by our setup.py on platforms that supposedly already have it
installed.

The entry in our setup.py (really _auto_deps.py) stanza that declares which
other packages we depend upon refers to a setuptools "Distribution" (which is
equivalent to a debian package). These distribution names are not case
sensitive, and one can use either hyphens or underscores to separate the
words. For example, "twisted-core", "Twisted-Core", and "Twisted_Core" are
all equivalent.

When Twisted-8.0.1 is built by running 'python setup.py install' on the
top-level setup.py, it produces a single .egg directory (i.e. a single
"distribution", named "Twisted".

When Twisted-8.0.1 is built by running 'setup.py install' on each individual
subproject's setup.py, it produces a separate .egg directory for each
subproject: Twisted-Core, Twisted-Web, etc. This is how debian/sid current
does it. In sid, the 'python-twisted' debian package is a metapackage that
depends upon 'python-twisted-core', 'python-twisted-web', etc. It does not
contain any .egg directories. So if you have debian sid, you have the
"Twisted-Core" distribution, but not the "Twisted" distribution. The most
recent debian release ("etch") has twisted-2.4.0, but no .egg files.

Ubuntu feisty and gutsy have Twisted-2.5.0, and have just the single
"Twisted" distribution. Dapper has Twisted-2.2.0, but does not have any .egg files.

Hardy has Twisted-2.5.0, and its "python-twisted-core" Deb package provides the "Twisted" distribution name.

The extra download/installs we've been seeing are because the tahoe setup.py
declares a dependency upon "Twisted", whereas the debian packages installed
on the system provide "Twisted-Core". The setuptools dependency language
doesn't provide for boolean-or, so we can't declare a dependency upon one or
the other.

So we need to decide what to do in the Tahoe setup.py:

  • depend upon "Twisted": builds on Feisty, Gutsy, and Hardy will not
    download anything extra, and will use the system Twisted instead. Builds
    on debian etch and sid will download Twisted-8.0.1 and install it into
    support/lib .
  • depend upon "Twisted-Core": builds on debian sid will not download
    anything extra. Builds on debian etch, and on ubuntu feisty/gutsy/hardy
    will download and install Twisted-8.0.1 .
  • modify our dependencies based upon whether
    pkg_resources.require("Twisted") succeeds or not. We could choose
    one of the two options above as our default, but then say that a system
    that provides "Twisted" will depend upon "Twisted" rather than
    "Twisted-Core", or vice-versa. This would avoid extra downloads on
    debian sid and ubuntu feisty/gutsy/hardy (i.e. all platforms on which
    the system Twisted has .egg_info data). However it would raise the
    question of what dependencies should wind up in the record on pypi.

I think Foolscap will need to make the same decision.

We've learned a bit today about the overzealous downloading/installation of Twisted by our setup.py on platforms that supposedly already have it installed. The entry in our setup.py (really _auto_deps.py) stanza that declares which other packages we depend upon refers to a setuptools "Distribution" (which is equivalent to a debian package). These distribution names are not case sensitive, and one can use either hyphens or underscores to separate the words. For example, "twisted-core", "Twisted-Core", and "Twisted_Core" are all equivalent. When Twisted-8.0.1 is built by running 'python setup.py install' on the top-level setup.py, it produces a single .egg directory (i.e. a single "distribution", named "Twisted". When Twisted-8.0.1 is built by running 'setup.py install' on each individual subproject's setup.py, it produces a separate .egg directory for each subproject: Twisted-Core, Twisted-Web, etc. This is how debian/sid current does it. In sid, the 'python-twisted' debian package is a metapackage that depends upon 'python-twisted-core', 'python-twisted-web', etc. It does not contain any .egg directories. So if you have debian sid, you have the "Twisted-Core" distribution, but not the "Twisted" distribution. The most recent debian release ("etch") has twisted-2.4.0, but no .egg files. Ubuntu feisty and gutsy have Twisted-2.5.0, and have just the single "Twisted" distribution. Dapper has Twisted-2.2.0, but does not have any .egg files. Hardy has Twisted-2.5.0, and its "python-twisted-core" Deb package provides the "Twisted" distribution name. The extra download/installs we've been seeing are because the tahoe setup.py declares a dependency upon "Twisted", whereas the debian packages installed on the system provide "Twisted-Core". The setuptools dependency language doesn't provide for boolean-or, so we can't declare a dependency upon one or the other. So we need to decide what to do in the Tahoe setup.py: * depend upon "Twisted": builds on Feisty, Gutsy, and Hardy will not download anything extra, and will use the system Twisted instead. Builds on debian etch and sid will download Twisted-8.0.1 and install it into support/lib . * depend upon "Twisted-Core": builds on debian sid will not download anything extra. Builds on debian etch, and on ubuntu feisty/gutsy/hardy will download and install Twisted-8.0.1 . * modify our dependencies based upon whether `pkg_resources.require("Twisted")` succeeds or not. We could choose one of the two options above as our default, but then say that a system that provides "Twisted" will depend upon "Twisted" rather than "Twisted-Core", or vice-versa. This would avoid extra downloads on debian sid and ubuntu feisty/gutsy/hardy (i.e. all platforms on which the system Twisted has .egg_info data). However it would raise the question of what dependencies should wind up in the record on pypi. I think Foolscap will need to make the same decision.
tahoe-lafs added the
packaging
major
task
1.0.0
 labels 2008-04-10 18:57:25 +00:00
tahoe-lafs added this to the undecided milestone 2008-04-10 18:57:25 +00:00
warner commented 2008-04-10 18:59:58 +00:00
Author
Owner
Copy link

Note: distutils has a 'provides' keyword argument, but it refers to packages (not distributions), and doesn't cause any additional information to get placed in the EGG-INFO data. We were hoping that we could convince the twisted folks to make their top-level setup.py declare that the "Twisted" distribution provides "Twisted-Core" and friends, but it looks like the machinery for that just isn't there.

We were also hoping that the setuptools dependency language was rich enough to allow OR clauses, so we could declare a dependency upon "Twisted | Twisted-Core", but it is not.

Note: distutils has a 'provides' keyword argument, but it refers to packages (not distributions), and doesn't cause any additional information to get placed in the EGG-INFO data. We were hoping that we could convince the twisted folks to make their top-level setup.py declare that the "Twisted" distribution provides "Twisted-Core" and friends, but it looks like the machinery for that just isn't there. We were also hoping that the setuptools dependency language was rich enough to allow OR clauses, so we could declare a dependency upon "Twisted | Twisted-Core", but it is not.
zooko commented 2008-04-10 19:34:14 +00:00
Author
Owner
Copy link

Ubuntu Hardy's "python-twisted-core" Deb package provides the "Twisted" distribution name.

Ubuntu Hardy's "python-twisted-core" Deb package provides the "Twisted" distribution name.
warner commented 2008-04-22 20:07:35 +00:00
Author
Owner
Copy link

FYI, here is the debian bug filed about this one: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=477384

FYI, here is the debian bug filed about this one: <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=477384>
warner commented 2008-06-01 20:20:08 +00:00
Author
Owner
Copy link

This is most probably fixed by the recent upload of python-twisted-8.1.0-1 into debian/sid. Note that the "Twisted.egg-info" file comes from the python-twisted package, not the python-twisted-core package (the latter still provides a Twisted-Core.egg-info file, but that doesn't matter as long as there is a Twisted.egg-info file present).

I need to double-check that this solves the problem on my work computer, but I'm 90% sure it's fixed now. If so, I'll close this ticket on monday.

This is most probably fixed by the recent upload of python-twisted-8.1.0-1 into debian/sid. Note that the "Twisted.egg-info" file comes from the python-twisted package, not the python-twisted-core package (the latter still provides a Twisted-Core.egg-info file, but that doesn't matter as long as there is a Twisted.egg-info file present). I need to double-check that this solves the problem on my work computer, but I'm 90% sure it's fixed now. If so, I'll close this ticket on monday.
tahoe-lafs modified the milestone from undecided to 1.1.0 2008-06-01 20:20:08 +00:00
warner commented 2008-06-02 20:01:22 +00:00
Author
Owner
Copy link

This is indeed fixed. (I was missing the python-twisted package on my work machine). Thanks doko!

This is indeed fixed. (I was missing the python-twisted package on my work machine). Thanks doko!
tahoe-lafs added the
fixed
 label 2008-06-02 20:01:22 +00:00
warner closed this issue 2008-06-02 20:01:22 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
No results found.
No results found.
Labels
Clear labels   
0.2.0

   
0.3.0

   
0.4.0

   
0.5.0

   
0.5.1

   
0.6.0

   
0.6.1

   
0.7.0

   
0.8.0

   
0.9.0

   
1.0.0

   
1.1.0

   
1.10.0

   
1.10.1

   
1.10.2

   
1.10a2

   
1.11.0

   
1.12.0

   
1.12.1

   
1.13.0

   
1.14.0

   
1.15.0

   
1.15.1

   
1.2.0

   
1.3.0

   
1.4.1

   
1.5.0

   
1.6.0

   
1.6.1

   
1.7.0

   
1.7.1

   
1.7β

   
1.8.0

   
1.8.1

   
1.8.2

   
1.8.3

   
1.8β

   
1.9.0

   
1.9.0-s3branch

   
1.9.0a1

   
1.9.0a2

   
1.9.0b1

   
1.9.1

   
1.9.2

   
1.9.2a1

   
LeastAuthority.com automation

   
blocker

   
cannot reproduce

   
cloud-branch

   
code

catch-all for anything that can be fixed by writing code but isn't classified better

  
code-dirnodes

anything involving tahoe directories

  
code-encoding

immutable-file encoding format/layout, cap format, encoding/decoding algorithms

  
code-frontend

general frontend things: new user-facing interfaces, FTP/SFTP servers, FUSE-like interfaces

  
code-frontend-cli

CLI tools

  
code-frontend-ftp-sftp

   
code-frontend-magic-folder

   
code-frontend-web

webapi interfaces, user-facing "WUI" interfaces

  
code-mutable

anything involving mutable files: encoding/decoding, share format

  
code-network

Introducer, locating storage servers, establishing/maintaining connections to them

  
code-nodeadmin

node startup/shutdown, tools to create nodes, logging tools, management/monitoring tools, manhole, disk-space-limiting tools

  
code-peerselection

server selection/sorting algorithm, rebalancing code, allocation policy, swarming-download

  
code-storage

storage-server implementation, share-storage directory layout, client-to-server share transfer protocol

  
contrib

problems with non-core things that live in the source:contrib/ directory

  
critical

   
defect

   
dev-infrastructure

things that help us build Tahoe: buildbot, automated speed/memory/code-coverage tests and results-displayers, IRC channels, mailing lists, this Trac instance

  
documentation

docs items. Also use 'docs' keyword on tickets in more specific components.

  
duplicate

   
enhancement

   
fixed

   
invalid

   
major

   
minor

   
n/a

   
normal

   
operational

things involved in running a tahoe grid, external tools to monitor/maintain a grid (like "nodeadmin" but larger-scale). Was also used for issues with the allmydata.com grid.

  
packaging

setup.py script, library dependencies, binary packages, licensing, installation instructions

  
somebody else's problem

   
supercritical

   
task

   
trivial

   
unknown

Uncategorized. All tickets default to this component until someone updates it.

  
was already fixed

   
website

things about the tahoe-lafs.org website (and sometimes this Trac instance, shared with 'dev-infrastructure')

  
wontfix

   
worksforme
No labels
0.2.0
0.3.0
0.4.0
0.5.0
0.5.1
0.6.0
0.6.1
0.7.0
0.8.0
0.9.0
1.0.0
1.1.0
1.10.0
1.10.1
1.10.2
1.10a2
1.11.0
1.12.0
1.12.1
1.13.0
1.14.0
1.15.0
1.15.1
1.2.0
1.3.0
1.4.1
1.5.0
1.6.0
1.6.1
1.7.0
1.7.1
1.7β
1.8.0
1.8.1
1.8.2
1.8.3
1.8β
1.9.0
1.9.0-s3branch
1.9.0a1
1.9.0a2
1.9.0b1
1.9.1
1.9.2
1.9.2a1
LeastAuthority.com automation
blocker
cannot reproduce
cloud-branch
code
code-dirnodes
code-encoding
code-frontend
code-frontend-cli
code-frontend-ftp-sftp
code-frontend-magic-folder
code-frontend-web
code-mutable
code-network
code-nodeadmin
code-peerselection
code-storage
contrib
critical
defect
dev-infrastructure
documentation
duplicate
enhancement
fixed
invalid
major
minor
n/a
normal
operational
packaging
somebody else's problem
supercritical
task
trivial
unknown
was already fixed
website
wontfix
worksforme
Milestone
Clear milestone
No items
No milestone
1.1.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: tahoe-lafs/trac-2024-07-25#378
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?