How is my Python code?
(raw.githubusercontent.com)
from the_citizen@lemmy.world to python@programming.dev on 25 Apr 2025 21:40
https://lemmy.world/post/28710209
from the_citizen@lemmy.world to python@programming.dev on 25 Apr 2025 21:40
https://lemmy.world/post/28710209
I don’t know if it’s the true place to ask, apologizing if not. I started to python one and half week ago. So I’m still beginner.
I made a terminal based weather application with python. What do you think about the code, is it good enough? I mean is it professional enough and how can I make the same functions with more less code?
Here’s the main file (I also added it as url to post): raw.githubusercontent.com/…/openweather.py
Here’s the config.json file: raw.githubusercontent.com/…/config.json
#python
threaded - newest
You appear to be afraid of spaces. Everything is cramped together.
Just bc you don’t have to put a space after colons or after equals and commas and whatnot doesn’t mean you shouldn’t
Don’t be afraid of spaces.
They make it easier for you to read your code when you come back later
Oops, sorry. I will revise the code and place spaces. Thanks for suggestion <3
Usually, you would use a formatter anyway - it’s good to know the standard way but for day to day coding I just have a shortcut bound that runs
ruff format(you can even have it done automatically on file save).I need to search formatters. Thank you for suggestion.
Ruff
Not the original commenter, but no need to apologise my friend. Nice work. Learning tip from me: give PEP 8 a read and save it for reference somewhere. It’s the standard for how to format Python code, and future you will thank you for internalising it early on in your Python journey
Thank you I will read it.
I revised the code. Added some spaces and comments for better readability. Hope it’s better now.
Instead you should just use an autoformatter. Black is good. Ruff is probably good too but I don’t have a lot of experience with it. YAPF is not good; don’t use it.
Too lazy to check the logic but if possible, consider using enums.
Yes I need to use enums. I realized it now.
I am pretty new myself, but if you didn’t know, here are some great free resources to help you.
inventwithpython.com
These are looking awesome. Thank you for sharing this <3
No problem at all! I hope it helps :)
Nice work! Here are a few notes:
The
WeatherAppobject has a mix of attributes with long-term (egself.LOCATIONS) and short-term (egself.city) relevance. Instance attributes introduced in places other than__init__, which makes it non-trivial for a reader to quickly understand what the object contains. And, actually,self.{city,lat,lon}are all only used from theadd_citymethod so they could/should be local variables instead of instance attributes (just remove theself.from them).There seem to maybe be some bugs around when things are lowercase and when not; for example checking
if self.city.lower() in self.LOCATIONSbut then when writing there the non-lowerself.ctiyis used as the key toself.LOCATIONS.The code under
if rep == “1”andelif rep == “2”is mostly duplicated, and there is noelsebranch to cover ifrepis something other than 1 or 2.It looks like the config only persists favorites so far (and not non-favorite cities which the user can add) which isn’t obvious from the user interface.
Passing both
locationandlocationsintoWeatherAPIso that it can look uplocations[location]is unnecessary; it would be clearer to pass in the dict for the specific location. It would also be possible to avoid the need forLOWLOCATIONSby adding a non-lowercasenamekey to the per-location dictionaries that just havelatandlonright now, and then keepingLOCATIONSkeyed by the lowercase names.HTH! happy hacking :)
That’s very informative, I will rewrite the code with your suggestions. Thank you!
It’s mostly ok, my immediate reaction is that it’s unnecessary to put the whole program into a class. Python isn’t Java. It’s fine to write procedures at the top level.
Also as someone said, consider using enums, and also the new case statement as of Python 3.10. Type annotations also can make things clearer. I’ve been using mypy to check mine but there are some alternatives now that might be better.
There is not much error checking but that can be ok if you are the only user.
If the config file might be crafted maliciously, it can use escape codes for a terminal playback attack: cyberark.com/…/dont-trust-this-title-abusing-term…
Be careful of that.
Yes I realized that I put everything to two classes. It’s too much. I’ll make more classes for more attributes.
I didn’t know enums until now and it’s awesome. I will do some exercises about it.
Last thing is interesting. I need to read that. Thank you for suggestions.
There’s no need to make more classes. You can move some of the code so it’s not in any class.
Pretty good for a week and a half! I would recommend setting up a project using
uvand also adding type hints and check them with Pyright (NOT Mypy).