-
Notifications
You must be signed in to change notification settings - Fork 0
Moves resource classes into separate files #4
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
Open
BeckyPauley
wants to merge
2
commits into
master
Choose a base branch
from
basic_app_structure
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| from flask_restful import Resource, reqparse | ||
|
|
||
| jobs = {} | ||
|
|
||
| class Job(Resource): | ||
| parser = reqparse.RequestParser() | ||
| parser.add_argument( | ||
| 'company', | ||
| type=str, | ||
| required=True, | ||
| help="This field cannot be left blank" | ||
| ) | ||
| parser.add_argument('salary') | ||
| parser.add_argument('status') | ||
|
|
||
| def post(self, title): | ||
|
|
||
| if jobs.get(title): | ||
| return{'message': f"A job with name '{title}' already exists"}, 400 | ||
|
|
||
| data = Job.parser.parse_args() | ||
|
|
||
| jobs.update( | ||
| {title : { | ||
| 'company': data['company'], | ||
| 'salary': data['salary'], | ||
| 'status': data['status'] | ||
| } | ||
| } | ||
| ) | ||
| return jobs[title], 201 | ||
|
|
||
| def get(self, title): | ||
| if jobs.get(title): | ||
| return jobs[title], 200 | ||
| else: | ||
| return{"message": f"A job with neme {title} does not exist"}, 404 | ||
|
|
||
| def put(self, title): | ||
|
|
||
| data = Job.parser.parse_args() | ||
|
|
||
| if jobs.get(title): | ||
| jobs[title].update(data), 200 | ||
| return jobs[title] | ||
| else: | ||
| return self.post(title) | ||
|
|
||
| def delete(self, title): | ||
| if jobs.get(title) == None: | ||
| return {'message': f"A job with name '{title}' does not exist"}, 400 | ||
| jobs.pop(title) | ||
| return {'message' : f"{title} deleted"}, 200 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| from flask_restful import Resource | ||
|
|
||
| import job | ||
|
|
||
| class JobsList(Resource): | ||
|
|
||
| def get(self): | ||
| return {"jobs": job.jobs}, 200 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be a perfectly valid Python thing, but how come the parser is being set up as what would be called a static member in C#? i.e. rather than putting it in the init method and assigning it to self.parser.
The main reason I'm asking is that this class feels difficult to write unit tests for. I don't know how much of a thing this is in the Flask world, but you can use this package:
https://github.com/alecthomas/injector
to add the ability to inject dependencies in to url handlers. So, here you could have the parser injected in the constructor, which would then give you the ability to mock it in a unit test, and therefore be able to write unit tests much more easily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To expand on this some more; I know that what you've got here is a very simple example ( no data store, for example), but I would be looking to split the data store (jobs) and the code that interacts with it, out in to a separate service class. This service class would then be injected in to this class. So this class would consist of the code to deal with getting the fields from the request, and the service class would deal with that data.
Does that make sense?