Sourcery refactored master branch by sourcery-ai[bot] · Pull Request #1 · Alpha-github/rest_api

sourcery-ai · 2022-11-05T06:00:38Z

Branch master refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the master branch, then run:

git fetch origin sourcery/master
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai · 2022-11-05T06:00:45Z

Sourcery Code Quality Report

❌ Merging this PR will decrease code quality in the affected files by 0.90%.

Quality metrics	Before	After	Change
Complexity	3.92 ⭐	3.29 ⭐	-0.63 👍
Method Length	69.57 🙂	71.00 🙂	1.43 👎
Working memory	8.00 🙂	8.71 🙂	0.71 👎
Quality	68.69% 🙂	67.79% 🙂	-0.90% 👎

Other metrics	Before	After	Change
Lines	87	82	-5

Changed files	Quality Before	Quality After	Quality Change
request_final.py	68.69% 🙂	67.79% 🙂	-0.90% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
request_final.py	user	3 ⭐	171 😞	12 😞	54.22% 🙂	Try splitting into smaller methods. Extract out complex expressions
request_final.py	test	7 ⭐	137 😞	10 😞	57.45% 🙂	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

sourcery-ai · 2022-11-05T06:02:20Z

request_final.py


 base_url  = "/api/v1"
-data_path = os.getcwd() + "/data.json"
+data_path = f"{os.getcwd()}/data.json"


Lines 9-9 refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-11-05T06:02:21Z

request_final.py

 #print(os.environ['LOG_LEVEL'])
 # GET
-@app.route(base_url + "/")
+@app.route(f"{base_url}/")


Function all refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-11-05T06:02:21Z

request_final.py

-@app.route(base_url + "/people/<int:t>")
+@app.route(f"{base_url}/people/<int:t>")
 def specific_id(t):
    with open (data_path, 'r') as f:
        user_data= json.load(f)
-    return jsonify(error = None, message = "Object with ID %s is displayed" % t , data = user_data['data'][t-1])
+    return jsonify(
+        error=None,
+        message=f"Object with ID {t} is displayed",
+        data=user_data['data'][t - 1],
+    )


Function specific_id refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-11-05T06:02:21Z

request_final.py

-@app.route(base_url + "/people" , methods = ["POST","GET"])
+@app.route(f"{base_url}/people", methods = ["POST","GET"])
 def test():
-    if request.method == "POST":
+    if request.method == "GET":
+        with open(data_path, 'r') as f:
+            user_data = json.load(f)
+            #print (user_data)
+        return jsonify({"error":None, "message":"Here is the required data", "data":user_data['data']})
+    elif request.method == "POST":
        a = request.json
-    
+
        with open(data_path, 'r') as f: #'r' - shows that the file should be read
            user_data = json.load(f) #json.load - used to deserialize/decode(convert json to py)
-            
+
        if len(a) == 0:
-            return jsonify(error = "present", message = "empty json obj") 
+            return jsonify(error = "present", message = "empty json obj")
+        if a in user_data['data']:
+            return jsonify(error = "present", message = "duplication") 
        else:
-            if a in user_data['data']:
-                return jsonify(error = "present", message = "duplication") 
-            else:
-                user_data['data'].append(a) #append - used to add an info in the existing dict
-
-
+            user_data['data'].append(a) #append - used to add an info in the existing dict
+
+
        with open(data_path,'w') as f:
            json.dump(user_data,f) #json.dump- used to serialize/encode(converting py to json)
 #json.dump is used to write data to a file.| json.dumps() is used to write to a python string
 # dump-converts dict of python to obj in json file.| dumps-converts dict obj of py to json string format
        return jsonify(error=None, message = "received sucesully")
-
-
-    elif request.method == "GET":
-        with open(data_path, 'r') as f:
-            user_data = json.load(f)
-            #print (user_data)
-        return jsonify({"error":None, "message":"Here is the required data", "data":user_data['data']})


Function test refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

Simplify conditional into switch-like form [×3] (switch)

Remove unnecessary else after guard condition (remove-unnecessary-else)

sourcery-ai · 2022-11-05T06:02:21Z

request_final.py

 # PUT 
-@app.route(base_url + "/people/data/<int:i>" , methods = ["PUT" , "GET","DELETE"])
+@app.route(f"{base_url}/people/data/<int:i>", methods = ["PUT" , "GET","DELETE"])
 def user(i):
-    if request.method == "PUT":
-        request_data = request.json
-
+    if request.method == "DELETE":
        with open(data_path , 'r') as f:
            user_data = json.load(f)
-
-        user_data['data'][i-1].update(request_data)
-
-        with open(data_path,'w') as f:
-            json.dump(user_data,f)
-        return jsonify(error = None, message = "Latest Obj Updated")
-        #return jsonify(info = user_data['data'][i-1])

-    elif request.method == "DELETE":
-
-        with open(data_path , 'r') as f:
-            user_data = json.load(f)
-
        user_data['data'].pop(i-1)

        with open(data_path,'w') as f:
            json.dump(user_data,f)
-        return jsonify(error = None, message = "Obj with ID %s is DELETED" % i )
-        #return jsonify(info = user_data['data'][i-1])
-
-
+        return jsonify(error = None, message=f"Obj with ID {i} is DELETED")
    elif request.method == "GET":
        with open(data_path , 'r') as f:
            user_data = json.load(f)
        return jsonify({"error":None, "message":"Here is the required data", "data":user_data['data']})


Function user refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

Simplify conditional into switch-like form [×3] (switch)

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

This removes the following comments ( why? ):

#return jsonify(info = user_data['data'][i-1])

sourcery-ai · 2022-11-05T06:02:21Z

request_final.py

-@app.route(base_url + "/people/count")
+@app.route(f"{base_url}/people/count")


Function count refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai bot requested a review from Alpha-github November 5, 2022 06:00

sourcery-ai bot force-pushed the sourcery/master branch from e434e29 to d0dd1ea Compare November 5, 2022 06:02

'Refactored by Sourcery'

db1972d

sourcery-ai bot force-pushed the sourcery/master branch from d0dd1ea to db1972d Compare November 5, 2022 06:02

sourcery-ai bot commented Nov 5, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored master branch#1

Sourcery refactored master branch#1
sourcery-ai[bot] wants to merge 1 commit intomasterfrom
sourcery/master

sourcery-ai bot commented Nov 5, 2022

Uh oh!

sourcery-ai bot commented Nov 5, 2022 •

edited

Loading

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

sourcery-ai bot Nov 5, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

		@app.route(base_url + "/people/count")
		@app.route(f"{base_url}/people/count")

Conversation

sourcery-ai bot commented Nov 5, 2022

Uh oh!

sourcery-ai bot commented Nov 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Nov 5, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants

sourcery-ai bot commented Nov 5, 2022 •

edited

Loading