exasol / python-styleguide

Python guide's, examples and tutorials

Exasol python-styleguide

Welcome to the Exasol python-styleguide. The styleguide(s) is not intend to be an universal text on how to do each single detail in python, it rather tries to rely on existing documents and guides references them (e.g. pep8) and their rules or it will add useful additions or exceptions where Exasol is diverging from the "norm" and will explain the reasons behind. commonly used patterns and style like pep8.

Build the Guide

1. Install the development dependencies

   poetry install
   

2. Build and open the styleguide

   nox
   

Note

Get help on the available actions

nox -l

python-styleguide's Issues

Describe best practices for testing

Maybe the style guide should name some best practices for (integration) testing?
I found particularly the following things very helpful:

• official documentation
• validate sys.exit()
• simulate command line arguments in sys.argv
• validate content written to stdout and stderr based on contextlib.redirect_stdout and contextlib.redirect_stderr which are part of the std since 3.4, 3.5
• In case you want to create integration tests for cli applications, consider prysk

Fix Link to Google's Python Style Guide

Summary

The current link (here) to Google's Python Style Guide in the Style section of the documentation is broken.

Expected Behavior

The link should direct users to the latest version of Google's Python Style Guide, ensuring that they have access to the most current guidelines and recommendations.

Actual Behavior

Currently, the link leads to a 404 error page.

Proposed Solution

Please update the link to point to the correct URL of Google's Python Style Guide.