r/learnpython • • Nov 05 '20

How does one learn to make well-structured programs? Mine are dumpster-fires.

So I just (kind-of) finished reading Automate The Boring Stuff With Python, and for the past month I've felt like a big-brained super-hero automating myself out of a job (Data Analyst).

The problem is, I feel I missing something along the way. I don't understand the proper way to use functions, what a class is, why people have multiple files in a program, how/why people use GitHub...probably some other things I haven't discovered yet.

They all seem to be related to organization? Is there a "How To Structure Your Python Stuff With Python" book?

478 Upvotes

98 comments sorted by

View all comments

370

u/pbw Nov 05 '20

There is an art and science to programming that must be learned that’s totally independent of any specific language. It takes time and practice and study.

You need to develop an engineering aesthetic so when you look at code you immediately see how it could be improved. Then you need the skills to push it into that shape without breaking tests or functionality in general.

There are books you can read but it’s somewhat like reading a book on how to play basketball. It can give you ideas but you have to practice it yourself, figure out your own ways of looking at things and doing things.

In writing (English) they say everyone has 100,000 words of poor writing in them. So the best you can do is speed through that to get the good stuff.

14

u/[deleted] Nov 05 '20

This is brilliantly put.

I'm no programmer, but I have an ambitious project I want to create and it's inspired me to try to learn C# (primarily due to the ease of Windows GUI design...). I'm a consummate planner, but even with this project my code is monolithic and, in a word, gross. I figure a weekend of organization could actually save me weeks, if not months, of recoding, as good organization prevents one from stepping on their own dick on the regular.

6

u/Solonotix Nov 05 '20

When working in C#, it's usually a good practice to create a class for every complex value you work with, each class should be its own file, and frequently it should have an accompanying interface in a separate namespace (sometimes it will be it's own project). What this does is separate definition (Interface) from implementation (Class), so that you can readily import the code that lets you interact, without needing the code that dictates how it all works.

From there, avoid the urge to put everything in your Program class, or Main method, and make each distinct data type a Class, and each distinct action should be a method. Any method signature that takes more than about 20 lines to spell out probably could be broken up into more manageable chunks (Note: 20 lines is not a hard rule, and instead just a soft indicator that you might be getting long-winded).

5

u/[deleted] Nov 06 '20

Pretty much the way I've decided to restructure things...Put keyboard handlers in their own class, mouse handlers in their own class, etc., etc., just to keep things clean (and portable, for future projects!).

Now if only I had time to dedicate to the project, I'd be on my way :D