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

Port foolscap to Python3 #2998

New issue
Closed
opened 2019-03-13 18:32:04 +00:00 by pythonhacker · 10 comments
pythonhacker commented 2019-03-13 18:32:04 +00:00
Owner
Copy link

Part of dependencies of tahoe-lfs, foolscap is only supported for Python2. This ticket addresses its porting steps to Python3.

Part of dependencies of tahoe-lfs, foolscap is only supported for Python2. This ticket addresses its porting steps to Python3.
tahoe-lafs added the
code
normal
task
1.12.1
 labels 2019-03-13 18:32:04 +00:00
tahoe-lafs added this to the undecided milestone 2019-03-13 18:32:04 +00:00
pythonhacker commented 2019-06-04 18:45:29 +00:00
Author
Owner
Copy link

Considering the discussions on https://github.com/warner/foolscap/issues/48 - not starting anything on this for now.

Considering the discussions on <https://github.com/warner/foolscap/issues/48> - not starting anything on this for now.
pythonhacker commented 2019-07-09 15:06:16 +00:00
Author
Owner
Copy link

Restarted work last week.

Restarted work last week.
pythonhacker commented 2019-07-09 15:11:55 +00:00
Author
Owner
Copy link

Figured out top files (modules) in foolscap source code by tracing system calls by running tahoe-lafs unit tests. These are,

Top 30 modules in decreasing order of sorted calls...


    foolscap/base32.py => 4194408
    foolscap/logging/log.py => 2540325
    foolscap/stringchain.py => 2403614
    foolscap/banana.py => 1954946
    foolscap/slicer.py => 664050
    foolscap/logging/incident.py => 453776
    foolscap/eventual.py => 448841
    foolscap/call.py => 287651
    foolscap/broker.py => 179140
    foolscap/constraint.py => 148022
    foolscap/slicers/root.py => 127975
    foolscap/slicers/dict.py => 106782
    foolscap/slicers/list.py => 103810
    foolscap/referenceable.py => 82494
    foolscap/slicers/tuple.py => 75613
    foolscap/schema.py => 70142
    foolscap/remoteinterface.py => 62729
    foolscap/negotiate.py => 48454
    foolscap/pb.py => 14599
    foolscap/slicers/bool.py => 8966
    foolscap/slicers/none.py => 8714
    foolscap/crypto.py => 5223
    foolscap/info.py => 3799
    foolscap/slicers/set.py => 2617
    foolscap/connection.py => 2518
    foolscap/reconnector.py => 2136
    foolscap/furl.py => 1840
    foolscap/util.py => 850
    foolscap/connections/tcp.py => 627
    foolscap/vocab.py => 538

Idea is to get the most "popular" source files so as to form some early foundation of the porting.

Figured out top files (modules) in foolscap source code by tracing system calls by running tahoe-lafs unit tests. These are, Top 30 modules in decreasing order of sorted calls... ``` foolscap/base32.py => 4194408 foolscap/logging/log.py => 2540325 foolscap/stringchain.py => 2403614 foolscap/banana.py => 1954946 foolscap/slicer.py => 664050 foolscap/logging/incident.py => 453776 foolscap/eventual.py => 448841 foolscap/call.py => 287651 foolscap/broker.py => 179140 foolscap/constraint.py => 148022 foolscap/slicers/root.py => 127975 foolscap/slicers/dict.py => 106782 foolscap/slicers/list.py => 103810 foolscap/referenceable.py => 82494 foolscap/slicers/tuple.py => 75613 foolscap/schema.py => 70142 foolscap/remoteinterface.py => 62729 foolscap/negotiate.py => 48454 foolscap/pb.py => 14599 foolscap/slicers/bool.py => 8966 foolscap/slicers/none.py => 8714 foolscap/crypto.py => 5223 foolscap/info.py => 3799 foolscap/slicers/set.py => 2617 foolscap/connection.py => 2518 foolscap/reconnector.py => 2136 foolscap/furl.py => 1840 foolscap/util.py => 850 foolscap/connections/tcp.py => 627 foolscap/vocab.py => 538 ``` Idea is to get the most "popular" source files so as to form some early foundation of the porting.
pythonhacker commented 2019-07-16 05:47:24 +00:00
Author
Owner
Copy link

Fixed all the Python3 basic port issues, now pyetst is collecting everything, tests are all executing but of course failing - which is progress at this stage :-)

	
$ pytest .
================================================= test session starts ==================================================
platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0
rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3
collected 534 items                                                                                                    

test__versions.py ...                                                                                            [  0%]
test_appserver.py FFFFFFFFFFFFFFFF...F                                                                           [  4%]
test_banana.py .............FE.................FEF.........FEFE..FE.....................FE....F...........FE.FEs [ 20%]
.Fss....FE.FEs..........F...                                                                                     [ 25%]
test_call.py .......................FE......FE...................FFFF                                            [ 35%]
test_connection.py .......FFFFFFF...FFFFFFFFFFFFFFFFFFFFFF                                                       [ 43%]
test_copyable.py .....FF..                                                                                       [ 44%]
test_crypto.py FFFF                                                                                              [ 45%]
test_eventual.py ...                                                                                             [ 46%]
test_gifts.py FFFFFFFFFFFFFFFF                                                                                   [ 49%]
test_info.py .FFFF.                                                                                              [ 50%]
test_interfaces.py .................                                                                             [ 53%]
test_keepalive.py FFFFF                                                                                          [ 54%]
test_listener.py FFFFF                                                                                           [ 55%]
test_logging.py .....F..F......F.FFFFFF..FFFFFFFFFFFFFFFFFFFFF.F.....FFFFFFFFEFE..                               [ 67%]
test_loopback.py F                                                                                               [ 67%]
test_negotiate.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF                                                        [ 74%]
test_observer.py .                                                                                               [ 75%]
test_pb.py .................FFFFFF.FFFFFF                                                                        [ 80%]
test_promise.py .....................                                                                            [ 84%]
test_reconnector.py FFFFFFF                                                                                      [ 85%]
test_reference.py .....                                                                                          [ 86%]
test_registration.py FFF                                                                                         [ 87%]
test_schema.py ..F.....F..F.FF....                                                                               [ 91%]
test_serialize.py ....FFFE                                                                                       [ 92%]
test_stringchain.py ........                                                                                     [ 93%]
test_sturdyref.py .F...                                                                                          [ 94%]
test_tub.py FFFFFFFFFFFFFFFF                                                                                     [ 97%]
test_unreachable.py FFF                                                                                          [ 98%]
test_util.py .........                                                                                           [100%]
Fixed all the Python3 basic port issues, now pyetst is collecting everything, tests are all executing but of course failing - which is progress at this stage :-) ``` $ pytest . ================================================= test session starts ================================================== platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0 rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3 collected 534 items test__versions.py ... [ 0%] test_appserver.py FFFFFFFFFFFFFFFF...F [ 4%] test_banana.py .............FE.................FEF.........FEFE..FE.....................FE....F...........FE.FEs [ 20%] .Fss....FE.FEs..........F... [ 25%] test_call.py .......................FE......FE...................FFFF [ 35%] test_connection.py .......FFFFFFF...FFFFFFFFFFFFFFFFFFFFFF [ 43%] test_copyable.py .....FF.. [ 44%] test_crypto.py FFFF [ 45%] test_eventual.py ... [ 46%] test_gifts.py FFFFFFFFFFFFFFFF [ 49%] test_info.py .FFFF. [ 50%] test_interfaces.py ................. [ 53%] test_keepalive.py FFFFF [ 54%] test_listener.py FFFFF [ 55%] test_logging.py .....F..F......F.FFFFFF..FFFFFFFFFFFFFFFFFFFFF.F.....FFFFFFFFEFE.. [ 67%] test_loopback.py F [ 67%] test_negotiate.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF [ 74%] test_observer.py . [ 75%] test_pb.py .................FFFFFF.FFFFFF [ 80%] test_promise.py ..................... [ 84%] test_reconnector.py FFFFFFF [ 85%] test_reference.py ..... [ 86%] test_registration.py FFF [ 87%] test_schema.py ..F.....F..F.FF.... [ 91%] test_serialize.py ....FFFE [ 92%] test_stringchain.py ........ [ 93%] test_sturdyref.py .F... [ 94%] test_tub.py FFFFFFFFFFFFFFFF [ 97%] test_unreachable.py FFF [ 98%] test_util.py ......... [100%] ```
pythonhacker commented 2019-07-17 18:02:45 +00:00
Author
Owner
Copy link

I am working on test_banana as it seems to test the biggest and most important module (banana.py).

Reduced failures from a starting 109 to 41.


$ pytest test_banana.py
================================================= test session starts ==================================================
platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0
rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3
collected 115 items                                                                                                    

...

-- Docs: https://docs.pytest.org/en/latest/warnings.html
========================= 41 failed, 69 passed, 5 skipped, 2 warnings, 1 error in 3.81 seconds =========================

I tried the py3 and py3.2 branches of warner's code and they have more errors in Python3 so clearly at this point my fork is at a better position.

I am working on `test_banana` as it seems to test the biggest and most important module (banana.py). Reduced failures from a starting 109 to 41. ``` $ pytest test_banana.py ================================================= test session starts ================================================== platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0 rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3 collected 115 items ... -- Docs: https://docs.pytest.org/en/latest/warnings.html ========================= 41 failed, 69 passed, 5 skipped, 2 warnings, 1 error in 3.81 seconds ========================= ``` I tried the py3 and py3.2 branches of warner's code and they have more errors in Python3 so clearly at this point my fork is at a better position.
pythonhacker commented 2019-07-18 12:42:16 +00:00
Author
Owner
Copy link

Failures reduced to 22. banana.py will soon pass with another session of porting.

$ pytest test_banana.py
================================================= test session starts ==================================================
platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0
rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3
collected 115 items                                                                                                    

test_banana.py ..........................................s....FFFFFFFFF..FFFFFFFF........F.FF.F.F......s..ss.... [ 84%]
...s..............                                                                                               [100%]

======================================================= FAILURES =======================================================


============================= 22 failed, 88 passed, 5 skipped, 2 warnings in 1.81 seconds ==============================
Failures reduced to 22. banana.py will soon pass with another session of porting. ``` $ pytest test_banana.py ================================================= test session starts ================================================== platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0 rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3 collected 115 items test_banana.py ..........................................s....FFFFFFFFF..FFFFFFFF........F.FF.F.F......s..ss.... [ 84%] ...s.............. [100%] ======================================================= FAILURES ======================================================= ============================= 22 failed, 88 passed, 5 skipped, 2 warnings in 1.81 seconds ============================== ```
pythonhacker commented 2019-07-22 15:30:55 +00:00
Author
Owner
Copy link

Yo! One milestone reached. All tests passing on test_banana.py!!!

(tahoe3) anand@anand-HP-Pavilion-Laptop-15-cc1xx:~/projects/anvetsu/tahoe/foolscap3/src/foolscap/test {2019-07-22 20:58:39}

$ pytest test_banana.py
========================================== test session starts ===========================================
platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0
rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3
collected 115 items                                                                                      

test_banana.py ................................................................................... [ 72%]
.....s..ss.......s..............                                                                   [100%]

============================================ warnings summary ============================================
test_banana.py:300
  /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:300: PytestCollectionWarning: cannot collect test class 'TestTransport' because it has a __init__ constructor (from: src/foolscap/test/test_banana.py)
    class TestTransport(io.StringIO):

test_banana.py:307
  /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:307: PytestCollectionWarning: cannot collect test class 'TestBytesTransport' because it has a __init__ constructor (from: src/foolscap/test/test_banana.py)
    class TestBytesTransport(io.BytesIO):

-- Docs: https://docs.pytest.org/en/latest/warnings.html
=========================== 111 passed, 4 skipped, 2 warnings in 0.43 seconds ============================
Yo! One milestone reached. All tests passing on test_banana.py!!! ``` (tahoe3) anand@anand-HP-Pavilion-Laptop-15-cc1xx:~/projects/anvetsu/tahoe/foolscap3/src/foolscap/test {2019-07-22 20:58:39} $ pytest test_banana.py ========================================== test session starts =========================================== platform linux -- Python 3.6.7, pytest-5.0.1, py-1.8.0, pluggy-0.12.0 rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3 collected 115 items test_banana.py ................................................................................... [ 72%] .....s..ss.......s.............. [100%] ============================================ warnings summary ============================================ test_banana.py:300 /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:300: PytestCollectionWarning: cannot collect test class 'TestTransport' because it has a __init__ constructor (from: src/foolscap/test/test_banana.py) class TestTransport(io.StringIO): test_banana.py:307 /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:307: PytestCollectionWarning: cannot collect test class 'TestBytesTransport' because it has a __init__ constructor (from: src/foolscap/test/test_banana.py) class TestBytesTransport(io.BytesIO): -- Docs: https://docs.pytest.org/en/latest/warnings.html =========================== 111 passed, 4 skipped, 2 warnings in 0.43 seconds ============================ ```
pythonhacker commented 2019-07-22 18:48:52 +00:00
Author
Owner
Copy link

Made the tests retroactively pass on Python2 also ... after the Python3 changes. Ain't it cool ?

(tahoe) anand@anand-HP-Pavilion-Laptop-15-cc1xx:~/projects/anvetsu/tahoe/foolscap3/src/foolscap/test {2019-07-2
3 00:17:43}
$ pytest test_banana.py
========================================== test session starts ===========================================
platform linux2 -- Python 2.7.15rc1, pytest-4.3.1, py-1.8.0, pluggy-0.9.0
hypothesis profile 'default' -> database=DirectoryBasedExampleDatabase('/home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/.hypothesis/examples')
rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3, inifile:
plugins: twisted-1.10, hypothesis-4.27.0
collected 115 items                                                                                      

test_banana.py ................................................................................... [ 72%]
.....s..ss.......s..............                                                                   [100%]

============================================ warnings summary ============================================
test_banana.py:301
  /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:301: PytestWarning: cannot collect test class 'TestTransport' because it has a __init__ constructor
    class TestTransport(io.StringIO):

test_banana.py:308
  /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:308: PytestWarning: cannot collect test class 'TestBytesTransport' because it has a __init__ constructor
    class TestBytesTransport(io.BytesIO):

-- Docs: https://docs.pytest.org/en/latest/warnings.html
=========================== 111 passed, 4 skipped, 2 warnings in 0.32 seconds ============================
Made the tests retroactively pass on Python2 also ... after the Python3 changes. Ain't it cool ? ``` (tahoe) anand@anand-HP-Pavilion-Laptop-15-cc1xx:~/projects/anvetsu/tahoe/foolscap3/src/foolscap/test {2019-07-2 3 00:17:43} $ pytest test_banana.py ========================================== test session starts =========================================== platform linux2 -- Python 2.7.15rc1, pytest-4.3.1, py-1.8.0, pluggy-0.9.0 hypothesis profile 'default' -> database=DirectoryBasedExampleDatabase('/home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/.hypothesis/examples') rootdir: /home/anand/projects/anvetsu/tahoe/foolscap3, inifile: plugins: twisted-1.10, hypothesis-4.27.0 collected 115 items test_banana.py ................................................................................... [ 72%] .....s..ss.......s.............. [100%] ============================================ warnings summary ============================================ test_banana.py:301 /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:301: PytestWarning: cannot collect test class 'TestTransport' because it has a __init__ constructor class TestTransport(io.StringIO): test_banana.py:308 /home/anand/projects/anvetsu/tahoe/foolscap3/src/foolscap/test/test_banana.py:308: PytestWarning: cannot collect test class 'TestBytesTransport' because it has a __init__ constructor class TestBytesTransport(io.BytesIO): -- Docs: https://docs.pytest.org/en/latest/warnings.html =========================== 111 passed, 4 skipped, 2 warnings in 0.32 seconds ============================ ```
pythonhacker commented 2019-09-03 10:06:59 +00:00
Author
Owner
Copy link

(https://docs.google.com/spreadsheets/d/1M_l5FjBWtzUEfY7NXyt95TydpVqC9KrwD2DtBDLU6Dw/edit#gid=0)

Approx plan for tests porting. Higher priority indicates higher priority temporally.

(https://docs.google.com/spreadsheets/d/1M_l5FjBWtzUEfY7NXyt95TydpVqC9KrwD2DtBDLU6Dw/edit#gid=0) Approx plan for tests porting. Higher priority indicates higher priority temporally.
exarkun commented 2020-01-09 18:22:03 +00:00
Author
Owner
Copy link

This is being tracked upstream now - https://github.com/warner/foolscap/issues/48

This is being tracked upstream now - <https://github.com/warner/foolscap/issues/48>
tahoe-lafs added the
somebody else's problem
 label 2020-01-09 18:22:03 +00:00
exarkun closed this issue 2020-01-09 18:22:03 +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
undecided
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#2998
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?