Refactoring Pygrr: the big rewrite!

Up until the 3rd August, 2021, Pygrr's code was contained in a single file, making it a "module". Well, that's not so good for maintainability, as there was so much going on in the same place. To make matters worse: there was no documentation for the file (bits of text that explain what each class or file does - for human benefit), and practically no code comments (small lines that explain what a bit of code does - for human benefit).

I could very easily take a break for a few months, come back, and have no idea what the code was doing, causing me to have to restart. Not only that though, as the alpha date looms ever-close, the prospect of Pygrr opening up open-source becomes, too, ever-close!

Now, I really don't want to show everyone the code with it being a horrible mess, that's like visiting a home-designer's house and it being a dump! So, I started to do something about that.

Python has an in-built "import" command, which allows you to include other modules, packages and files into your code. This means that it basically takes the code, and adds it to your file, metaphorically speaking!

So, I began a rewrite then, and I've been hard at work since. That explains the lack of posts, and, for those of you subscribed, the lack of newsletters.

So, let's split Pygrr and Pygrr PolyArt into packages, with sub-package folders inside them!

You'll see some common recurrences here, notably the file "__init__.py". Well, .py is the file extension for a Python script, but __init__? That's a default Python method, which is opened upon instantiation.

Jargon free, basically, when that package is imported, all of the code in __init__ is run - allowing us to import further files and run code. 

With the amount of .py files now, the prospect of users opening one of the files individually occurs, which would just throw an error, as they're meant to be imported as a package - so, let's do something funny to fix it!

So, the vision is as follows:

The file should detect when it is not being imported;
The file should tell the user what the file is meant to be used for;
The file should tell the user it shouldn't be ran - in a fun way;
The file should close.

So, Python has ways of doing the first two - Google "docstrings in python", and "__name__ in python". The last one is easy, just run the command quit().

And for the only one remaining? I'm going to give the file sentience...

 "oooooooooooh" - I hear you all say...

Well, not really, it should just greet the user with a custom message... So, I whipped up a quick module that gave the desired output, called it "sysmessages", and plugged it into every file. Don't worry, each message isn't hard coded, it takes them from a text file containing each message, for easy changeability!

Here's how it looks if I run, say, _canvas.py...

As you can see, it first prints out the documentational description of the file, and then says something. When the user presses enter, it will quit!

That's weird, you weren't meant to run me...

Hi! I'm not sure how you got here, but, oh well!

Wrong file buddy!

Hey... I'm not supposed to be ran!

I'm alive! Hang on, oh, oops, gotta go!

Ay, you found me!

Don't let me catch you running this file again, buckaroo...

These are all (currently) of the messages it can choose from. Anyways;

Isaac, over and out...

Popular posts from this blog

Messing around with procedural art - Turtle graphics

Let's take a short break from Pygrr to delve back into the world of Turtle graphics. Turtle graphics: an introduction Well, what are they? Turtle graphics are a simple vector graphic system in programming that uses a relative cursor known as a Turtle to plot data onto a Cartesian plane. Nice, that didn't clear it up at all! To put it simply, Turtle graphics are a type of programming concept where an object (consider it a "pen") is moved around a 2D canvas, drawing wherever it goes! Most people who know Python will be aware of the Turtle module - this is a Pythonic implementation of Turtle graphics (fun fact: it uses Tkinter too, like Pygrr!). Turtle graphics are a key feature of the programming language "Logo". Uses of Turtle graphics Turtle graphics are a popular way to introduce programming to kids, and are often used for this! They are also used as a quick way to implement graphic representation of data when debugging or writing code, as they are super ea...
Read more

The fossils of Morocco | Mosasaurus beaugei

Finally, another post! Life has been quite difficult recently, and I've had a lot of appointments in the hospital, and, combined with a much higher workload, I haven't had too much free time. Anyways, enough of that! A couple of weeks ago, I acquired a gorgeous fish and mosasaur association, from a seller on the web. It hails from the Cretaceous of Khouribga, Morocco, unprepped, just split out of the rock! Here's the fossil in question! Ignore the mess in the background... Can you believe this thing is 70.6 - 66 million years old!? Look at the sheer awesome preservation on that fish spine; absolutely stunning! So, story time. The tooth is from the species "Mosasaurus beaugei" , a pretty large mosasaurine. Pictures from www.prehistoric-wildlife.com Here's a nice image (or, 2 images...) of the size of Mosasaurus (silhouette 16) against other mosasaurines, and a human. As yo...
Read more

Blog post #0 - Hello, world!

From humble beginnings... Hi, I'm Isaac. I've been in the programming world for almost 7 years now! I started this blog to share my love of fossils and coding with you guys, the world. I'm obsessed with palaeontology, and I have a real passion for teaching others what I love, be it programming, game development, or fossil things. What am I up to? Well, you'll have to wait and see... Just kidding, I'm currently working on: A voxel (3D cube, game) engine as a basis for many other games I have planned A free Python (programming language) library for game development, called "Pygrr"... You'll see more on this very soon! Nice to meet you all, if you feel the sudden urge to send me an email, head over to my "about me" page! Isaac, over and out...
Read more