Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aspen.resources API break not documented #436

Closed
techtonik opened this issue Jun 14, 2015 · 11 comments
Closed

aspen.resources API break not documented #436

techtonik opened this issue Jun 14, 2015 · 11 comments

Comments

@techtonik
Copy link
Contributor

resources.get() changed in 0.35 from def get(request):
https://github.com/gratipay/aspen-python/blob/0.34/aspen/resources/__init__.py#L160
to def get(website, fspath):
https://github.com/gratipay/aspen-python/blob/0.35/aspen/resources/__init__.py#L160

With no traces in https://github.com/gratipay/aspen-python/blob/master/Changelog.md#035---released-thu-oct-30-2014-by-whit537

At the very least I expected major version bump. At maximum - migration guide.

@pjz
Copy link
Contributor

pjz commented Jun 15, 2015

Two things:

  1. We haven't hit 1.0 so we consider all APIs still unstable and subject to change

  2. I'm not sure that aspen.resources.get() is really a 'public' API anyway: it's used internally, but as a web framework I think Aspen's API is more about the Website object and the things that get used in simplates. I'd love to hear arguments on the other side, though!

@techtonik
Copy link
Contributor Author

@pjz I tried to update Aspen for inside.gratipay.com and got some stacktrace on that. I can not continue, because I do not understand the error. I can repeat and post it here tomorrow, but maybe you can immediately say what was changed and needs to be fixed here.
https://github.com/gratipay/inside.gratipay.com/blob/1fc02bc111e4444f204b250066cae489f9a29a3d/configure-aspen.py

I think of Aspen as of pythonic PHP.

@pjz
Copy link
Contributor

pjz commented Jun 18, 2015

You're going to need to provide an error for any chance of help with this.

@techtonik
Copy link
Contributor Author

@pjz it was answered here - gratipay/inside.gratipay.com#263 (comment) and there is anohter trace at gratipay/inside.gratipay.com#263 (comment) which didn't occur with previous version.

@chadwhitacre
Copy link
Contributor

@techtonik Make a PR against Changelog, ya?

@techtonik
Copy link
Contributor Author

@whit537 I don't know what to write there. I don't know what is nav.py doing and for the moment there are other things I am researching. Changelog may not be the best place for it. Something more user level like https://mercurial.selenic.com/wiki/UpgradeNotes with no distracting details.

@pjz
Copy link
Contributor

pjz commented Jun 19, 2015

nav.py isn't part of aspen. Gratipay != Aspen.

@pjz pjz closed this as completed Jun 19, 2015
@techtonik
Copy link
Contributor Author

nav.py may use Aspen API that apparently become broken.

@pjz
Copy link
Contributor

pjz commented Jun 21, 2015

See my first comment.

@techtonik
Copy link
Contributor Author

Then why maintain changelog at all?

@techtonik
Copy link
Contributor Author

And if that's an internal API, shouldn't it be prefixed with _?

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

No branches or pull requests

3 participants