Sage-Bionetworks / synapsePythonClient

Programmatic interface to Synapse services for Python
https://www.synapse.org
Apache License 2.0
65 stars 67 forks source link

[SYNPY-1476] Splitting logic for downloading content from client.py #1103

Closed BryanFauble closed 3 weeks ago

BryanFauble commented 1 month ago

Problem:

  1. There is a significant amount of business logic within client.py related to configuration and downloading of files.
  2. Many warnings were popping up when running unit/integration tests.
  3. As items are being migrated out we will need to mark them as deprecated.
  4. Lot's of items are flagged by sonarcloud that need to be addressed.

Solution:

  1. Laying the ground work for migrating logic out of client.py. I started this process by splitting functions out into synapseclient/api/configuration_services.py, synapseclient/api/file_services.py, and synapseclient/core/download/download_functions.py
  2. Updating unit/integration tests for items I saw that were spitting out warnings or other code smells.
  3. Marking items as deprecated and updating all internal usage of those deprecated methods to their replacements.
  4. Starting to address some sonarcloud flagged issues.

Testing:

  1. Light manual testing but mostly focusing on unit/integration testing around these changes. Further PRs will include heavier testing of downloading logic that is split out of client.py
pep8speaks commented 1 month ago

Hello @BryanFauble! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 381:89: E501 line too long (193 > 88 characters) Line 387:89: E501 line too long (102 > 88 characters) Line 419:89: E501 line too long (133 > 88 characters)

Line 673:89: E501 line too long (111 > 88 characters) Line 835:89: E501 line too long (119 > 88 characters) Line 856:89: E501 line too long (121 > 88 characters) Line 872:89: E501 line too long (131 > 88 characters) Line 894:89: E501 line too long (115 > 88 characters) Line 1624:89: E501 line too long (139 > 88 characters) Line 1648:89: E501 line too long (122 > 88 characters) Line 1744:89: E501 line too long (134 > 88 characters) Line 3191:89: E501 line too long (115 > 88 characters) Line 3241:89: E501 line too long (129 > 88 characters) Line 3262:89: E501 line too long (125 > 88 characters) Line 3389:89: E501 line too long (134 > 88 characters) Line 3454:89: E501 line too long (116 > 88 characters) Line 3472:89: E501 line too long (119 > 88 characters)

Line 43:89: E501 line too long (99 > 88 characters) Line 76:89: E501 line too long (101 > 88 characters) Line 86:89: E501 line too long (101 > 88 characters) Line 87:89: E501 line too long (110 > 88 characters) Line 93:89: E501 line too long (89 > 88 characters) Line 115:89: E501 line too long (104 > 88 characters) Line 138:89: E501 line too long (101 > 88 characters) Line 139:89: E501 line too long (102 > 88 characters) Line 171:89: E501 line too long (91 > 88 characters) Line 172:89: E501 line too long (96 > 88 characters) Line 174:89: E501 line too long (92 > 88 characters) Line 244:89: E501 line too long (101 > 88 characters) Line 245:89: E501 line too long (102 > 88 characters) Line 246:89: E501 line too long (109 > 88 characters) Line 275:89: E501 line too long (103 > 88 characters) Line 301:89: E501 line too long (91 > 88 characters) Line 302:89: E501 line too long (97 > 88 characters) Line 339:89: E501 line too long (118 > 88 characters) Line 360:89: E501 line too long (107 > 88 characters) Line 361:89: E501 line too long (112 > 88 characters) Line 363:89: E501 line too long (109 > 88 characters) Line 433:89: E501 line too long (91 > 88 characters) Line 467:89: E501 line too long (111 > 88 characters) Line 468:89: E501 line too long (109 > 88 characters) Line 469:89: E501 line too long (99 > 88 characters) Line 518:89: E501 line too long (114 > 88 characters) Line 519:89: E501 line too long (114 > 88 characters) Line 520:89: E501 line too long (107 > 88 characters) Line 521:89: E501 line too long (109 > 88 characters) Line 522:89: E501 line too long (113 > 88 characters) Line 538:89: E501 line too long (96 > 88 characters) Line 566:89: E501 line too long (109 > 88 characters) Line 611:89: E501 line too long (99 > 88 characters) Line 627:89: E501 line too long (89 > 88 characters) Line 647:89: E501 line too long (93 > 88 characters) Line 684:89: E501 line too long (106 > 88 characters)

Line 262:89: E501 line too long (91 > 88 characters)

Line 99:89: E501 line too long (100 > 88 characters)

Line 438:89: E501 line too long (90 > 88 characters) Line 441:89: E501 line too long (94 > 88 characters) Line 475:89: E501 line too long (90 > 88 characters) Line 527:89: E501 line too long (90 > 88 characters)

Line 323:89: E501 line too long (94 > 88 characters) Line 391:89: E501 line too long (90 > 88 characters) Line 446:89: E501 line too long (90 > 88 characters)

Comment last updated at 2024-06-05 16:43:59 UTC