Skip to main content

Extensible code style checker currently supporting Fortran, PSyclone DSL, etc

Project description

Stylist

Stylist is a code style checking tool built on a framework which supports multiple styles across multiple languages.

But aren't there many code style checking tools out there, why create a new one?

The simple reason is that few of them support Fortran, a language still in widespread use in the scientific computing domain. They can also tend towards the zealous when enforcing the "one true style" whereas long running science models tend to diverge quite radically in what they like, style-wise.

Large models also tend to be implemented using more than one language so a tool which is capable of understanding all of them would be welcomed by science developers.

Thus a tool was developed based on a framework which hopes to support ready extension and reconfiguration.

The project is still in its infancy so only a few rules have been implemented and only for Fortran. Stubs are provided to show how it might be extended to support C.

Find the project at https://github.com/MetOffice/stylist

Installation

Installation can be as simple as pip install stylist or conda install -c conda-forge stylist.

As always it is also possible to install from the project source by running python setup.py. The source may be obtained by downloading a tarball or by cloning the repository.

Usage

Stylist provides a command-line tool stylist for normal use. It can also be used as a package if you want to integrate it with another tool. Documentation regarding this second option is maintained in the project wiki.

On the Command Line

The command-line tool is not complicated to use:

stylist [-help] [-verbose] [-configuration FILENAME] [-style NAME] FILE ...

The only required arguments are one or more filenames. These are the files which will be checked. If a directory is specified then the tool will automatically descend into it checking all files which it recognises by extension.

If you want a running commentary of what the tool is doing then use the -verbose argument.

A configuration file may specified with -configuration . This file should be formatted as documented below.

The configuration may define several styles, in which case one can be chosen using the -style argument. If it is not then the first in the configuration file will be used.

Configuration File

The configuration file is in Windows .ini format.

The processing pipelines for different file types are specified in the file-pipe section. Each key is the file extension and the value a colon separated list of processors starting with the language. See stylist -help for a list of processors.

[file-pipe]
x90=fortran:pfp:fpp

Styles are defined in sections called style.<name>. In this section is expected a key rules with a comma separated list of rules as the value. These rules may take parameters which are presented in parenthesis.

[style.<name>]
rules = FortranCharacterset, KindPattern(integer='i_.*', real='r_.*')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stylist-0.2.tar.gz (20.0 kB view hashes)

Uploaded source

Built Distribution

stylist-0.2-py3-none-any.whl (21.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page