Pylint rc file for GRASS - Revision history

⚠️Wenzeslaus: noting the config file in the source code

2013-07-13T08:01:33Z

noting the config file in the source code

← Older revision		Revision as of 08:01, 13 July 2013
Line 1:		Line 1:
			''Note that content of this page maybe outdated. There is a Pylint configuration file directly in the source code ([http://trac.osgeo.org/grass/browser/grass/trunk/tools/pylintrc.txt <tt>tools/pylintrc.txt</tt>]). There is an cofiguration file for <tt>pep8</tt> tool, too ([http://trac.osgeo.org/grass/browser/grass/trunk/tools/pep8config.txt <tt>tools/pep8config.txt</tt>]).''

	[http://www.pylint.org/ Pylint] is static code analyser for Python. You can use it for detecting errors in your source codes or to help follow coding standards. However, default Pylint configuration is not compatible with GRASS Python coding style. The rc file is on this page (use copy and paste).		[http://www.pylint.org/ Pylint] is static code analyser for Python. You can use it for detecting errors in your source codes or to help follow coding standards. However, default Pylint configuration is not compatible with GRASS Python coding style. The rc file is on this page (use copy and paste).

Line 17:		Line 19:

	== Pylint rc file ==		== Pylint rc file ==

			''Note that there is a [http://trac.osgeo.org/grass/browser/grass/trunk/tools/pylintrc.txt <tt>tools/pylintrc.txt</tt>] file directly in the source code.''

	''This version is not suitable for wxGUI but can be used for Python scripts.''		''This version is not suitable for wxGUI but can be used for Python scripts.''

2013-03-18T12:18:32Z

Notes: pep8 space

← Older revision		Revision as of 12:18, 18 March 2013
Line 296:		Line 296:
	Or you can disable warning for particular class, function or line. Note that in all cases comment must be on that particular line!		Or you can disable warning for particular class, function or line. Note that in all cases comment must be on that particular line!
	<source lang="python">		<source lang="python">
	class RHoughParametres: # pylint: disable=R0903		class RHoughParametres: # pylint: disable=R0903
	"""! Small crate class."""		"""! Small crate class."""
	def __init__(self):		def __init__(self):

2012-12-06T23:57:33Z

Pylint rc file: not fully synchronized but more or less for wxGUI (older change on wiki)

← Older revision		Revision as of 23:57, 6 December 2012
Line 18:		Line 18:
	== Pylint rc file ==		== Pylint rc file ==

	''This version is not ~~(yet)~~ suitable for wxGUI but can be used for Python scripts.''		''This version is not suitable for wxGUI but can be used for Python scripts.''

	Get a copy of the file with:		Get a copy of the file with (not fully synchronized):
	<source lang="bash">		<source lang="bash">
	git clone git://gist.github.com/3089272.git gist-3089272		git clone git://gist.github.com/3089272.git gist-3089272
	</source>		</source>

	The content is: https://gist.github.com/3089272		The content is (not fully synchronized): https://gist.github.com/3089272
	<source lang="ini">		<source lang="ini">
	[MASTER]		[MASTER]

2012-12-06T23:54:31Z

pylint link

← Older revision		Revision as of 23:54, 6 December 2012
Line 1:		Line 1:
	Pylint is static code analyser for Python. You can use it for detecting errors in your source codes or to help follow coding standards. However, default Pylint configuration is not compatible with GRASS Python coding style. The rc file is on this page (use copy and paste).		[http://www.pylint.org/ Pylint] is static code analyser for Python. You can use it for detecting errors in your source codes or to help follow coding standards. However, default Pylint configuration is not compatible with GRASS Python coding style. The rc file is on this page (use copy and paste).

	__TOC__		__TOC__
Line 322:		Line 322:

	== External links ==		== External links ==
			* Pylint official website, http://www.pylint.org/
	* [Python-projects] Pylint and gettext. How to reconcile? http://lists.logilab.org/pipermail/python-projects/2006-April/000714.html		* [Python-projects] Pylint and gettext. How to reconcile? http://lists.logilab.org/pipermail/python-projects/2006-April/000714.html
	* Pylint plugin to find non-i18n/gettext strings, http://www.technomancy.org/python/pylint-i18n-lint-checker/		* Pylint plugin to find non-i18n/gettext strings, http://www.technomancy.org/python/pylint-i18n-lint-checker/

2012-11-25T11:06:59Z

Pylint rc file: method-rgx

← Older revision		Revision as of 11:06, 25 November 2012
Line 130:		Line 130:

	# Regular expression which should only match correct method names		# Regular expression which should only match correct method names
	method-rgx=[a-z_][a-zA-Z0-9_]{2,30}$		method-rgx=[a-zA-Z_][a-zA-Z0-9_]{2,30}$

	# Regular expression which should only match correct instance attribute names		# Regular expression which should only match correct instance attribute names

2012-08-10T19:02:32Z

+ Fedora

← Older revision		Revision as of 19:02, 10 August 2012
Line 308:		Line 308:
	== Pylint installation ==		== Pylint installation ==

	''~~Commands are valid for~~ Ubuntu (10.04).''		''Installation on Ubuntu (10.04):''

	# latest version		# latest version
	sudo apt-get install pip # only if you don't have pip		sudo apt-get install pip # only if you don't have pip
	sudo pip install pylint		sudo pip install pylint

	# alternatively version from repository		# alternatively version from repository
	sudo apt-get install pylint		sudo apt-get install pylint

			''Installation on Fedora:''

			yum install pylint python-pip

	== External links ==		== External links ==

2012-08-10T15:04:31Z

Pylint installation: installation on Ubuntu

← Older revision		Revision as of 15:04, 10 August 2012
Line 305:		Line 305:

	Do not use <tt>pylint: disable</tt> comment too often!		Do not use <tt>pylint: disable</tt> comment too often!

			== Pylint installation ==

			''Commands are valid for Ubuntu (10.04).''

			# latest version
			sudo apt-get install pip # only if you don't have pip
			sudo pip install pylint

			# alternatively version from repository
			sudo apt-get install pylint


	== External links ==		== External links ==

2012-07-25T14:44:00Z

Pylint rc file: \\todo,@todo added to notes warning

← Older revision		Revision as of 14:44, 25 July 2012
Line 159:		Line 159:

	# List of note tags to take in consideration, separated by a comma.		# List of note tags to take in consideration, separated by a comma.
	notes=FIXME,TODO		# Warning about both: ad hoc uppercase and Doxygen TODO notes
			notes=FIXME,TODO,\\todo,@todo

	# general regexp for convention, warning etc. would be great		# general regexp for convention, warning etc. would be great

2012-07-25T14:16:14Z

Notes: one line disable

@@ Line 291: / Line 291: @@
      CENTER = 2
 # pylint: enable=W0232,R0903
 </source>

2012-07-25T13:19:19Z

How to use rc file

← Older revision		Revision as of 13:19, 25 July 2012
Line 7:		Line 7:
	You can specify rc file by <tt>--rcfile</tt> Pylint's command line option:		You can specify rc file by <tt>--rcfile</tt> Pylint's command line option:
	pylint --rcfile=grass_pylintrc module_or_package		pylint --rcfile=grass_pylintrc module_or_package
	If you are using Python editor which allows Pylint analysis but not ~~allows~~ specify Pylint's command line parameters (e.g. Spyder) you can create or replace <tt>.pylintrc</tt> file in your home directory.		If you are using Python editor which allows Pylint analysis but does not allow to specify Pylint's command line parameters (e.g. Spyder) you can create or replace <tt>.pylintrc</tt> file in your home directory.
	# for GNU/Linux		# for GNU/Linux
	cd ~		cd ~
	cp .pylintrc .pylintrc_old		mv .pylintrc .pylintrc_old
	cp grass_pylintrc .pylintrc		mv grass_pylintrc .pylintrc

	Note that you can also use Pylint for error checking only:		Note that you can also use Pylint for error checking only: