Summary:

Add API for working with data from a package repository.

Review Request #7693 — Created Oct. 11, 2015 and submitted Oct. 21, 2015, 2:09 p.m.

Information
Owner:	chipx86
Repository:	rbpkg
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	rbpkg
People:

Description

This introduces a set of classes for serializing/deserializing package

data stored in a repository, and classes for interacting with the

repository. It can be used to query packages, the available versions,

installation instructions, and more.
Each entry in the repository is a PackageBundle, which bundles together

a list of channels (PackageChannel). Each of these manages state for a

range of versions (1.0.x, 1.5.x, 2.0.x, etc.), and may also be mapped to

one or more aliases (beta, stable, etc.).
Each channel lists all available releases (PackageChannel), and also

contains rules (PackageRules) on how to install any given version.
These objects are populated with data from the repository through

deserialization class methods that they provide. That data comes from a

PackageDataLoader subclass, which knows how to fetch and deserialize

JSON data from a backend (the main package repository, a testing

repository, etc.).
Currently, there's no data loader implemented to talk to any

HTTPS-backed repository, nor are there any classes for

managing/installing packages beyond fetching data on them. Those will

come in future changes.

Testing Done

Unit tests pass.
Implemented a test command locally, and used it to introspect package data.

Issues

Description	From	Last Updated
Col: 1 E302 expected 2 blank lines, found 1	reviewbot	Oct. 11, 2015, 4:34 p.m.
Docstring?	david	Oct. 20, 2015, 1:04 p.m.
How would you feel about making these arguments to __init__?	david	Oct. 13, 2015, 6:42 p.m.
Some here?	david	Oct. 13, 2015, 6:41 p.m.
And here?	david	Oct. 13, 2015, 6:41 p.m.
And here?	david	Oct. 13, 2015, 6:41 p.m.
Col: 1 W391 blank line at end of file	reviewbot	Oct. 20, 2015, 1:03 p.m.

Tool: Pyflakes
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/package.py
    rbpkg/api/errors.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py



Tool: PEP8 Style Checker
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/package.py
    rbpkg/api/errors.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py

rbpkg/api/errors.py (Diff revision 1)

Show all issues

Col: 1
 E302 expected 2 blank lines, found 1

rbpkg/api/loaders.py (Diff revision 1)

Show all issues

Docstring?

chipx86 Oct. 13, 2015, 6:42 p.m.

It's covered by the base class, and has nothing to add beyond that.

rbpkg/api/package.py (Diff revision 1)

Show all issues

How would you feel about making these arguments to __init__?

chipx86 Oct. 13, 2015, 6:42 p.m.

Yeah, I'm fine with it. Initially, the design was a bit different and it didn't make sense to have __init__ take care of it (only tests would set the data outside of deserialization, and the objects were given a URL and were told to load() from it, but now we have deserialize class methods). That changed later in the development. That's why these are set up how they are.

rbpkg/api/package.py (Diff revision 1)
Show all issues
```
Some here?
```
rbpkg/api/package.py (Diff revision 1)
Show all issues
```
And here?
```
rbpkg/api/package.py (Diff revision 1)
Show all issues
```
And here?
```

Change Summary:


Split the classes into their own files.
__init__ on each class now takes arguments to set the attributes, and call sites have been updated to use that.
Renamed PackageVersionSeries to PackageChannel.
Renamed PackageVersion to PackageRelease.

Description:

		This introduces a set of classes for serializing/deserializing package
		data stored in a repository, and classes for interacting with the
		repository. It can be used to query packages, the available versions,
		installation instructions, and more.

		Each entry in the repository is a `PackageBundle`, which bundles together
~		a list of version series (`PackageVersionSeries`). Each of these manages
~		state for a range of versions (1.0.x, 1.5.x, 2.0.x, etc.), and may also
~		be mapped to one or more aliases (beta, stable, etc.).
	~	a list of channels (`PackageChannel`). Each of these manages state for a
	~	range of versions (1.0.x, 1.5.x, 2.0.x, etc.), and may also be mapped to
	~	one or more aliases (beta, stable, etc.).

~		Each version series lists all available versions in that series
~		(`PackageVersion`), and also contains rules (`PackageRules`) on how to
	~	Each channel lists all available releases (`PackageChannel`), and also
	~	contains rules (`PackageRules`) on how to install any given version.
-		install any given version.

		These objects are populated with data from the repository through
		deserialization class methods that they provide. That data comes from a
		`PackageDataLoader` subclass, which knows how to fetch and deserialize
		JSON data from a backend (the main package repository, a testing
		repository, etc.).

		Currently, there's no data loader implemented to talk to any
		HTTPS-backed repository, nor are there any classes for
		managing/installing packages beyond fetching data on them. Those will
		come in future changes.

Diff:

Revision 2 (+1512)

Show changes

	setup.py
	rbpkg/api/__init__.py
	rbpkg/api/errors.py
	rbpkg/api/loaders.py
	rbpkg/api/package_bundle.py
	rbpkg/api/package_channel.py
	rbpkg/api/package_release.py
	rbpkg/api/package_repo.py
	7 more

Tool: PEP8 Style Checker
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/tests/test_package_channel.py
    rbpkg/api/tests/testcases.py
    rbpkg/api/tests/test_package_rules.py
    rbpkg/api/package_bundle.py
    rbpkg/api/package_channel.py
    rbpkg/api/errors.py
    rbpkg/api/package_rules.py
    rbpkg/api/tests/test_package_release.py
    rbpkg/api/package_release.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package_bundle.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py



Tool: Pyflakes
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/tests/test_package_channel.py
    rbpkg/api/tests/testcases.py
    rbpkg/api/tests/test_package_rules.py
    rbpkg/api/package_bundle.py
    rbpkg/api/package_channel.py
    rbpkg/api/errors.py
    rbpkg/api/package_rules.py
    rbpkg/api/tests/test_package_release.py
    rbpkg/api/package_release.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package_bundle.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py

rbpkg/api/package_rules.py (Diff revision 2)
Show all issues
```
Col: 1
 W391 blank line at end of file
```

Change Summary:


Added some docstrings.
Removed a blank line.

Diff:

Revision 3 (+1547)

Show changes

	setup.py
	rbpkg/api/__init__.py
	rbpkg/api/errors.py
	rbpkg/api/loaders.py
	rbpkg/api/package_bundle.py
	rbpkg/api/package_channel.py
	rbpkg/api/package_release.py
	rbpkg/api/package_repo.py
	7 more

Tool: Pyflakes
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/tests/test_package_channel.py
    rbpkg/api/tests/testcases.py
    rbpkg/api/tests/test_package_rules.py
    rbpkg/api/package_bundle.py
    rbpkg/api/package_channel.py
    rbpkg/api/errors.py
    rbpkg/api/package_rules.py
    rbpkg/api/tests/test_package_release.py
    rbpkg/api/package_release.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package_bundle.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py



Tool: PEP8 Style Checker
Processed Files:
    rbpkg/api/loaders.py
    rbpkg/api/tests/test_package_channel.py
    rbpkg/api/tests/testcases.py
    rbpkg/api/tests/test_package_rules.py
    rbpkg/api/package_bundle.py
    rbpkg/api/package_channel.py
    rbpkg/api/errors.py
    rbpkg/api/package_rules.py
    rbpkg/api/tests/test_package_release.py
    rbpkg/api/package_release.py
    rbpkg/api/package_repo.py
    setup.py
    rbpkg/api/tests/test_package_bundle.py

Ignored Files:
    rbpkg/api/__init__.py
    rbpkg/api/tests/__init__.py

Ship it!

```
Ship It!
```

Review Board 6.0 alpha 0 (dev)

Add API for working with data from a package repository.

Change Summary:

Description:

Diff:

Change Summary:

Diff:

Status: Closed (submitted)