Skip to content

Experimental client: renaming - #1401

Merged
jku merged 5 commits into
theupdateframework:experimental-clientfrom
sechkova:dirs-and-names
May 21, 2021
Merged

Experimental client: renaming#1401
jku merged 5 commits into
theupdateframework:experimental-clientfrom
sechkova:dirs-and-names

Conversation

@sechkova

@sechkovasechkova commented May 20, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes#1397
Description of the changes being introduced by the pull request:

Note: this is done on top of changes introduced by #1396

Proposes the following client naming and directory structure:

tuf/
ngclient/
__init__.py
updater.py
metadatabundle.py
network/
__init__.py
requestsfetcher.py
download.py

Most significant changes:

  • client_rework -> ngclient (next-gen-client): almost what @jku suggested but trying to avoid dashes (not accepted) and underscores (not recommended) in package names.
  • client public classes are exposed in ngclient/__init__.py
  • download related modules are moved under network. FetcherInterface is defined in network/__init__.py instead of fetcher.py
  • new client code is excluded from coverage until better tested

Please verify and check that the pull request fulfills the following
requirements:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@sechkova
sechkova requested a review from jkuMay 20, 2021 11:48
@sechkovasechkova mentioned this pull request May 20, 2021
Closed
@sechkovasechkova added the experimental-client Items related to the development of a new client (see milestone/8 and theexperimental-client branch) label May 20, 2021
@jku

jku commented May 20, 2021•
edited
Loading

Copy link
Copy Markdown
Member

Note that the names here are not package names: they're just module names where underscores can be used if it improves readability... but I'm fine with ngclient, no better ideas at the moment

@jku

jku commented May 20, 2021•
edited
Loading

Copy link
Copy Markdown
Member

The reason I suggested ngclient._internal is that the name makes it obvious to an outsider that they should not rely on things inside this module -- we want to be able to change them when we want. ngclient.network does not convey that and I don't think we can assume outsiders understand that ngclient (the init.py) defines what our API is and that tings below it are off-limits (as much as I otherwise like the concept).

@jku

jku commented May 20, 2021

Copy link
Copy Markdown
Member

Note that the names here are not package names: they're just module names where underscores can be used if it improves readability... but I'm fine with ngclient, no better ideas at the moment

I'll just correct myself here: they do seem to call any directory with __init__.py a package.

I still maintain _internal is a fine name for a directory: this what a lot of big name python projects do (see pip for an example).

@sechkova

sechkova commented May 20, 2021

Copy link
Copy Markdown
ContributorAuthor

Agreed with @jku's review to move non-public modules to _internal.
The new structure is:

tuf/
ngclient/
__init__.py
updater.py
fetcher.py
_internal/
requests_fetcher.py
download.py
metadata_bundle.py

Also rebased on latest changes in experimental-client branch.

jku
jku approved these changes May 20, 2021
View reviewed changes

@jkujku left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

There's obviously many valid choices here but I'm happy with ones made here

@jku

jku commented May 21, 2021

Copy link
Copy Markdown
Member

For some reason github claims there are conflicts here after merging 1403 -- manual rebase works without any issues though?

@sechkova
Rename client_rework to ngclient
c64a6f9
The current client and the next-gen client should
coexist in the same repository during the ongoing
development of the latter.
Looking for a name which is client-related,
short, meeting PEP8 package names requirements.
Currently "ngclient" seems to fit in until a
better proposal comes.
Rename updater_rework.py to updater.py
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@sechkova
Move non-public modules to nglient/_internal
c29051c
Separate public/private API. Keep modules
containing the piblic classes in the main client
directory and move the rest to _internal.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@sechkova
Expose client public classes from __init__.py
3f1aa10
Only "Updater" and "FetcherInterface" are considered
public classes of the client. Exposing them in __init__.py
makes usage and access simpler.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@sechkova
Combine paths in tox.ini
d57d36f
Use the same call of black, isort, pylint to cover
multiple directories.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@sechkova
Omit ngclient from coverage check
18c5272
Restore coverage back to 97% but omit ngclient
form the overall score until tests are implemented.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@sechkova

sechkova commented May 21, 2021

Copy link
Copy Markdown
ContributorAuthor

Yep, rebased.

@sechkova
sechkova changed the base branch from experimental-client to developMay 21, 2021 07:34
@sechkova
sechkova changed the base branch from develop to experimental-clientMay 21, 2021 07:38
@jku
jku merged commit 5f37eb3 into theupdateframework:experimental-clientMay 21, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jkujkujku approved these changes

Assignees

No one assigned

Labels

experimental-clientItems related to the development of a new client (see milestone/8 and theexperimental-client branch)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sechkova@jku