pldiiw / 1ads-mp1

SUPINFO 1ADS-MP1

1ADS-MP1

Synopsis

This repository is the result of the work I put into the SUPINFO's home work project, 1ADS-MP1, where students were asked to reproduce in Python three little pawns games, namely Breaktrough by Dan Troyka, Frank Harary's First Attack and 2002's Pleiadis by Christian Watkins in cooperation with Jan Kristian Haugland.

Followed Guidelines

This project was an opportunity for me to experiment some concepts I read about and was curious to see in action.

Clarity

First things first, a huge emphasis was put into clarity of code. Statistics saying that developers spend about 70% of their time reading other people code, considering the reading experience should be a priority for everyone. This translate here as the most descriptive doctrings as possible, inline comments when things get a bit obfuscated, extensive variable and function naming and straight-to-the-goal statements.

Functional Programming

The use of a functional programming-like approach helped. Apart from IO and lists' side-effect-loving element modifications, I tried to write as pure as possible functions. This resulted in a lot of functions being defined, for the majority short ones, bringing higher abstraction in the code as a whole, and astonishingly pleasant code to write and read.

Function Annotation

New feature in Python, you can now add metadata annotations to functions' arguments and return values, enabling you to declare typing! I used it because the ability to type check your functions can prevent bugs ahead of runtime, which, again, might result in a huge gain of time.

Testing

You will see a test directory. This directory contains a test suite for each one of the games. This practice let me write my sources files and afterwards check every written functions if they produce the results I expected from them. It prevented many unseen bugs in the whole writing process and saved time in ingame testing.

PEP-8 and Code Linting

Standards are meant to be followed. It helps developers find their marks quicker by bearing consistency across projects. It goes hand in hand with clarity. I tried to follow the PEP-8 as close as possible and used the pylint tool to avoid syntax mistakes.

Git

The Git version control software is a tool that became unavoidable in the IT world. Except for the fact that I use it on a everyday basis, the bias to use it on this project was to have a more organized workflow and keep track of how I managed to accomplish the writing of the 3 games. This repository is also hosted on GitHub if you're willing to explore the repository in a pleasant way.

Project Hierarchy

All games source files can be found in the src directory.
Tests are under the test directory.

Installation

Requires Python 3.5+.

Clone repository

git clone https://github.com/pldiiw/1ads-mp1.git

Run one of the game

python3 src/<game_file> <parameters>

Running a game with no parameters will display the help and expected parameters.

Tests

If you're willing to, you can run the test suite.

Requires mypy. If don't have it, just run:

sudo pip3 install mypy-lang

Run the test script

./run_tests.sh

License

This repository is under the Unlicense. See the LICENSE for more information.
Keep in mind that the final version (tagged as v1.0.0) delivered to SUPINFO is automatically licensed under the FreeBSD to SUPINFO International University according to their regulation.