Skip to content

Shipping split fixes, docs - #7

Merged
bwbeach merged 76 commits into
Backblaze:masterfrom
reef-technologies:shipping_split_fixes
Apr 2, 2019
Merged

bwbeach merged 76 commits into
Backblaze:masterfrom
reef-technologies:shipping_split_fixes

Conversation

@pawelpolewicz

Copy link
Copy Markdown

No description provided.

@ppolewicz ppolewicz mentioned this pull request Apr 1, 2019
@bwbeach

bwbeach commented Apr 1, 2019

Copy link
Copy Markdown
Contributor

I haven't looked at every commit, but I did clone the repository and take a look at the overall structure.

A few comments on the code:

  • I don't think contrib/bash_completion is needed; it's only for the command-line tool.
  • It would be more convenient for users if the most-used classes, like B2Api wore available in the top-level package.
  • Some files are missing copyrights. I think the CLI has a check for that.
  • DownloadTests in test_bucket.py does not inherit from a test base class.

And the docs:

  • I gentle introduction for newbies would be good.
  • B2Api.__init__ is tricky. The docs should say what the default values are for the parameters, and which are required.
  • B2Api.authorize_account takes a realm. What should the caller pass in?

@ppolewicz

Copy link
Copy Markdown
Collaborator
  • contrib/bash_completion removed
  • the structure of the API should change in v1.0.0, we wanted to get everything working in the current structure and then design a new interface once we have the testing harness and everything associated with it
  • the check for copyrights will be improved in the next PR (I already wrote it, but do not want to pollute this PR so that it can be reviewed properly)
  • DownloadTests in test_bucket.py should not inherit from test base class - if it did, those tests would be executed. DownloadTests collects the test cases and later on other classes inherit from it to run the scenarios on "their" transferer class. I checked the test logs and it looks that this works correctly (we run tests for default transferer, parallel transferer and simple transferer but not for DownloadTests itself - as intended)

As for the docs, the listed issues as well as fixing ToC (if I can figure it out) will be done in next PRs to unblock the migration.

@bwbeach
bwbeach merged commit c8c3fcd into Backblaze:master Apr 2, 2019
@pawelpolewicz
pawelpolewicz deleted the shipping_split_fixes branch April 19, 2019 19:58
@goanpeca goanpeca mentioned this pull request Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants