Page MenuHomeSealhub
Files F7187800

No OneTemporary
Actions

View Options

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6b193c3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.phutil_module_cache
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..5c304d1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c45513
--- /dev/null
+++ b/README.md
@@ -0,0 +1,139 @@
+# Arcanist Linters
+
+This is a collection of custom [Arcanist][] linters that we've written at
+Pinterest.
+
+## Linters
+
+### Apache Thrift Linter
+
+Lints for errors in [Apache Thrift](http://thrift.apache.org/) IDL (schema)
+files using the `thrift` compiler.
+
+```json
+{
+ "type": "thrift",
+ "include": "(\\.thrift$)",
+ "flags": [
+ "--allow-64bit-consts"
+ ],
+ "version": ">= 0.9.0",
+ "thrift.generators": [
+ "py:dynamic,utf8strings,new_style,slots",
+ "java",
+ "go",
+ "erl"
+ ],
+ "thrift.includes": [
+ ".",
+ "common"
+ ]
+}
+```
+
+### Go Vet Linter
+
+Uses the [Go vet command](https://golang.org/cmd/vet/) to lint for suspicious
+code constructs.
+
+```json
+{
+ "type": "govet",
+ "include": "(^src/example.com/.*\\.go$)"
+}
+```
+
+### Python Debugger Linter
+
+Hunts for stray Python debugger ([pdb][]) statements.
+
+[pdb]: https://docs.python.org/2/library/pdb.html
+
+```json
+"pdb": {
+ "type": "python-debugger",
+ "include": "(\\.py$)"
+}
+```
+
+### Python Imports Linter
+
+Lints for illegal Python module imports.
+
+```json
+{
+ "type": "python-imports",
+ "python-imports.pattern": "(mock)",
+ "include": "(\\.py$)",
+ "exclude": "(^tests/)"
+}
+```
+
+### Python Requirements Linter
+
+Ensures Python package requirements in [requirements.txt files][req-txt] are
+sorted and unique.
+
+```json
+{
+ "type": "requirements-txt",
+ "include": "(requirements.txt$)"
+}
+```
+
+[req-txt]: https://pip.readthedocs.org/en/latest/user_guide/#requirements-files
+
+## Installation
+
+In short, you'll need to add this repository to your local machine and tell
+Arcanist to load the extension. You either can do this globally or on a
+per-project basis.
+
+Once installed, the individual linters can be enabled and configured via the
+project's `.arclint` file. See the [Arcanist Lint User Guide][lint-guide] for
+details.
+
+## Global Installation
+
+Arcanist can load modules from an absolute path, but because it also searches
+for modules one level up from itself on the filesystem, it's convenient to
+clone this repository at the same level as `arcanist` and `libphutil`.
+
+```
+$ git clone https://github.com/pinterest/arcanist-linters.git pinterest-linters
+$ ls
+arcanist
+pinterest-linters
+libphutil
+```
+
+Then, tell Arcanist to load the module by editing `~/.arcconfig` (or
+`/etc/arcconfig`):
+
+```json
+{
+ "load": ["pinterest-linters"]
+}
+```
+
+## Project Installation
+
+You can also load `arcanist-linters` on a per-project basis. In that case,
+using a [git submodule](https://git-scm.com/docs/git-submodule) is probably
+the most convenient approach.
+
+```
+$ git submodule add https://github.com/pinterest/arcanist-linters.git .pinterest-linters
+$ git submodule update --init
+```
+
+Then, enable the module in your project-level `.arcconfig` file:
+
+```json
+{
+ "load": [".pinterest-linters"]
+}
+```
+
+[Arcanist]: https://secure.phabricator.com/book/phabricator/article/arcanist/
+[lint-guide]: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/
diff --git a/__phutil_library_init__.php b/__phutil_library_init__.php
new file mode 100644
index 0000000..2dce04e
--- /dev/null
+++ b/__phutil_library_init__.php
@@ -0,0 +1,3 @@
+<?php
+
+phutil_register_library('pinterest-linters', __FILE__);
diff --git a/__phutil_library_map__.php b/__phutil_library_map__.php
new file mode 100644
index 0000000..e474c15
--- /dev/null
+++ b/__phutil_library_map__.php
@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * This file is automatically generated. Use 'arc liberate' to rebuild it.
+ *
+ * @generated
+ * @phutil-library-version 2
+ */
+phutil_register_library_map(array(
+ '__library_version__' => 2,
+ 'class' => array(
+ 'ApacheThriftLinter' => 'src/ApacheThriftLinter.php',
+ 'GoVetLinter' => 'src/GoVetLinter.php',
+ 'PythonDebuggerLinter' => 'src/PythonDebuggerLinter.php',
+ 'PythonImportsLinter' => 'src/PythonImportsLinter.php',
+ 'PythonRequirementsLinter' => 'src/PythonRequirementsLinter.php',
+ ),
+ 'function' => array(),
+ 'xmap' => array(
+ 'ApacheThriftLinter' => 'ArcanistExternalLinter',
+ 'GoVetLinter' => 'ArcanistExternalLinter',
+ 'PythonDebuggerLinter' => 'ArcanistLinter',
+ 'PythonImportsLinter' => 'ArcanistLinter',
+ 'PythonRequirementsLinter' => 'ArcanistLinter',
+ ),
+));
diff --git a/src/ApacheThriftLinter.php b/src/ApacheThriftLinter.php
new file mode 100644
index 0000000..4d1d4cc
--- /dev/null
+++ b/src/ApacheThriftLinter.php
@@ -0,0 +1,175 @@
+<?php
+/**
+ * Copyright 2016 Pinterest, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Lints Apache Thrift IDL files using the "thrift" compiler.
+ */
+final class ApacheThriftLinter extends ArcanistExternalLinter {
+
+ private $generators = array();
+ private $includes = array();
+ private $tmpdir = null;
+
+ public function getInfoName() {
+ return 'Apache Thrift Linter';
+ }
+
+ public function getInfoDescription() {
+ return pht('Validates Thrift files');
+ }
+
+ public function getInfoURI() {
+ return 'https://thrift.apache.org/';
+ }
+
+ public function getLinterName() {
+ return 'THRIFT';
+ }
+
+ public function getLinterConfigurationName() {
+ return 'thrift';
+ }
+
+ public function getLinterConfigurationOptions() {
+ $options = array(
+ 'thrift.generators' => array(
+ 'type' => 'list<string>',
+ 'help' => pht("List of code generators to use."),
+ ),
+ 'thrift.includes' => array(
+ 'type' => 'optional list<string>',
+ 'help' => pht('List of directories searched for include directives.'),
+ ),
+ );
+
+ return $options + parent::getLinterConfigurationOptions();
+ }
+
+ public function setLinterConfigurationValue($key, $value) {
+ switch ($key) {
+ case 'thrift.generators':
+ if (empty($value)) {
+ throw new Exception(pht('At least one generator must be specified.'));
+ }
+ $this->generators = $value;
+ return;
+ case 'thrift.includes':
+ $this->includes = $value;
+ return;
+ }
+
+ return parent::setLinterConfigurationValue($key, $value);
+ }
+
+ public function getDefaultBinary() {
+ return 'thrift';
+ }
+
+ public function getVersion() {
+ list($err, $stdout, $stderr) = exec_manual(
+ '%C -version',
+ $this->getExecutableCommand());
+
+ $matches = array();
+ if (preg_match('/\b(?P<version>\d+\.\d+\.\d+)\b/', $stdout, $matches)) {
+ return $matches['version'];
+ } else {
+ return false;
+ }
+ }
+
+ public function getInstallInstructions() {
+ return pht(
+ 'Install thrift using `%s` (OS X) or `%s` (Linux).',
+ 'brew install thrift',
+ 'apt-get install thrift');
+ }
+
+ public function shouldExpectCommandErrors() {
+ return true;
+ }
+
+ protected function getMandatoryFlags() {
+ if ($this->tmpdir == null) {
+ $this->tmpdir = Filesystem::createTemporaryDirectory('arc-lint-thrift-');
+ }
+
+ $flags = array('-out', $this->tmpdir);
+ foreach ($this->generators as $generator) {
+ array_push($flags, '--gen', $generator);
+ }
+ foreach ($this->includes as $dir) {
+ array_push($flags, '-I', $dir);
+ }
+ return $flags;
+ }
+
+ protected function canCustomizeLintSeverities() {
+ return false;
+ }
+
+ protected function didResolveLinterFutures(array $futures) {
+ if ($this->tmpdir != null) {
+ Filesystem::remove($this->tmpdir);
+ $this->tmpdir = null;
+ }
+
+ return parent::didResolveLinterFutures($futures);
+ }
+
+ protected function parseLinterOutput($path, $err, $stdout, $stderr) {
+ $lines = phutil_split_lines($err ? $stderr : $stdout, false);
+ $regex = '/^\[(?P<severity>[A-Z]+):(?P<path>.*):(?P<lineno>\d+)\]\s+(?P<message>[^\(].*)$/';
+
+ $messages = array();
+ foreach ($lines as $line) {
+ $matches = null;
+ if (preg_match($regex, $line, $matches)) {
+ // Older versions of Thrift (<0.9) generate output for included files.
+ // Ignore any entries for files other than the active path.
+ if (!Filesystem::pathsAreEquivalent($path, $matches['path'])) {
+ continue;
+ }
+
+ $message = new ArcanistLintMessage();
+ $message->setPath($path);
+ $message->setLine($matches['lineno']);
+ $message->setCode($this->getLinterName());
+ $message->setName($this->getLinterName());
+ $message->setDescription($matches['message']);
+ $message->setSeverity($this->getMatchSeverity($matches['severity']));
+ $messages[] = $message;
+ }
+ }
+
+ return array_unique($messages, SORT_REGULAR);
+ }
+
+ private function getMatchSeverity($name) {
+ $map = array(
+ 'ERROR' => ArcanistLintSeverity::SEVERITY_ERROR,
+ 'FAILURE' => ArcanistLintSeverity::SEVERITY_ERROR,
+ 'WARNING' => ArcanistLintSeverity::SEVERITY_WARNING,
+ );
+
+ if (array_key_exists($name, $map)) {
+ return $map[$name];
+ }
+
+ return ArcanistLintSeverity::SEVERITY_ERROR;
+ }
+}
diff --git a/src/GoVetLinter.php b/src/GoVetLinter.php
new file mode 100644
index 0000000..a24a6ae
--- /dev/null
+++ b/src/GoVetLinter.php
@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copyright 2016 Pinterest, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Uses the Go vet command to lint for suspicious code constructs.
+ */
+final class GoVetLinter extends ArcanistExternalLinter {
+
+ public function getInfoName() {
+ return 'Vet';
+ }
+
+ public function getInfoDescription() {
+ return pht('Vet examines Go source code and reports suspicious constructs.');
+ }
+
+ public function getInfoURI() {
+ return 'https://golang.org/cmd/vet/';
+ }
+
+ public function getLinterName() {
+ return 'GOVET';
+ }
+
+ public function getLinterConfigurationName() {
+ return 'govet';
+ }
+
+ public function getDefaultBinary() {
+ return 'go';
+ }
+
+ public function getVersion() {
+ list($err, $stdout, $stderr) = exec_manual(
+ '%C version',
+ $this->getExecutableCommand());
+
+ $matches = array();
+ if (preg_match('/\bgo(?P<version>\d+\.\d+(?:.\d+|rc\d+))\b/', $stdout, $matches)) {
+ return $matches['version'];
+ } else {
+ return false;
+ }
+ }
+
+ public function getInstallInstructions() {
+ return pht('Vet is part of the go tool.');
+ }
+
+ protected function getMandatoryFlags() {
+ return array('tool', 'vet');
+ }
+
+ public function shouldExpectCommandErrors() {
+ return true;
+ }
+
+ protected function canCustomizeLintSeverities() {
+ return true;
+ }
+
+ protected function parseLinterOutput($path, $err, $stdout, $stderr) {
+ $lines = phutil_split_lines($stderr, false);
+
+ $messages = array();
+ foreach ($lines as $line) {
+ $matches = explode(':', $line, 3);
+
+ if (count($matches) === 3) {
+ $message = new ArcanistLintMessage();
+ $message->setPath($path);
+ $message->setLine($matches[1]);
+ $message->setCode($this->getLinterName());
+ $message->setName($this->getLinterName());
+ $message->setDescription(ucfirst(trim($matches[2])));
+ $message->setSeverity(ArcanistLintSeverity::SEVERITY_ADVICE);
+
+ $messages[] = $message;
+ }
+ }
+
+ return $messages;
+ }
+}
diff --git a/src/PythonDebuggerLinter.php b/src/PythonDebuggerLinter.php
new file mode 100644
index 0000000..ed1750e
--- /dev/null
+++ b/src/PythonDebuggerLinter.php
@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright 2016 Pinterest, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Hunts for stray Python debugger (pdb) statements.
+ */
+final class PythonDebuggerLinter extends ArcanistLinter {
+
+ const LINT_BREAKPOINT = 1;
+
+ public function getInfoName() {
+ return 'Python Debugger Linter';
+ }
+
+ public function getInfoDescription() {
+ return pht('Hunts for stray Python debugger (pdb) statements.');
+ }
+
+ public function getInfoURI() {
+ return 'https://docs.python.org/2/library/pdb.html';
+ }
+
+ public function getLinterName() {
+ return 'PYTHON-DEBUGGER';
+ }
+
+ public function getLinterConfigurationName() {
+ return 'python-debugger';
+ }
+
+ public function getLintNameMap() {
+ return array(
+ self::LINT_BREAKPOINT => pht('Python debugger breakpoint'),
+ );
+ }
+
+ protected function canCustomizeLintSeverities() {
+ return false;
+ }
+
+ public function lintPath($path) {
+ $lines = phutil_split_lines($this->getData($path), false);
+ $regex = '/\b(i?pdb\.set_trace)\b/';
+
+ foreach ($lines as $lineno => $line) {
+ $matches = array();
+ if (preg_match($regex, $line, $matches, PREG_OFFSET_CAPTURE)) {
+ list($breakpoint, $offset) = $matches[1];
+ $this->raiseLintAtLine(
+ $lineno + 1,
+ $offset + 1,
+ self::LINT_BREAKPOINT,
+ pht('This line contains a Python debugger breakpoint.'),
+ $breakpoint);
+ }
+ }
+ }
+}
diff --git a/src/PythonImportsLinter.php b/src/PythonImportsLinter.php
new file mode 100644
index 0000000..2f90227
--- /dev/null
+++ b/src/PythonImportsLinter.php
@@ -0,0 +1,99 @@
+<?php
+/**
+ * Copyright 2016 Pinterest, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Lints for illegal Python module imports.
+ */
+final class PythonImportsLinter extends ArcanistLinter {
+
+ const LINT_IMPORT = 1;
+
+ private $pattern;
+ private $message;
+
+ public function getInfoName() {
+ return 'Python Imports Linter';
+ }
+
+ public function getInfoDescription() {
+ return pht('Lints for illegal Python module imports.');
+ }
+
+ public function getLinterName() {
+ return 'PYTHON-IMPORTS';
+ }
+
+ public function getLinterConfigurationName() {
+ return 'python-imports';
+ }
+
+ public function getLintNameMap() {
+ return array(
+ self::LINT_IMPORT => pht('Illegal Import'),
+ );
+ }
+
+ public function getLinterConfigurationOptions() {
+ $options = array(
+ 'python-imports.pattern' => array(
+ 'type' => 'string',
+ 'help' => pht('Module name pattern.'),
+ ),
+ 'python-imports.message' => array(
+ 'type' => 'optional string',
+ 'help' => pht('Message to display when caught.'),
+ ),
+ );
+
+ return $options + parent::getLinterConfigurationOptions();
+ }
+
+ public function setLinterConfigurationValue($key, $value) {
+ switch ($key) {
+ case 'python-imports.pattern':
+ $this->pattern = $value;
+ return;
+ case 'python-imports.message':
+ $this->message = $value;
+ return;
+
+ default:
+ return parent::setLinterConfigurationValue($key, $value);
+ }
+ }
+
+ public function lintPath($path) {
+ $lines = phutil_split_lines($this->getData($path), false);
+ $regex = "/^\s*(from|import)\s+(?P<module>{$this->pattern})\b/";
+
+ foreach ($lines as $lineno => $line) {
+ $matches = array();
+ if (preg_match($regex, $line, $matches, PREG_OFFSET_CAPTURE)) {
+ list($module, $offset) = $matches['module'];
+ $this->raiseLintAtLine(
+ $lineno + 1,
+ $offset + 1,
+ self::LINT_IMPORT,
+ pht(
+ 'This line imports a module ("%s") that is not allowed in '.
+ 'this file. %s',
+ $module, $this->message),
+ $module);
+ }
+ }
+ }
+}
diff --git a/src/PythonRequirementsLinter.php b/src/PythonRequirementsLinter.php
new file mode 100644
index 0000000..dc3dbe6
--- /dev/null
+++ b/src/PythonRequirementsLinter.php
@@ -0,0 +1,120 @@
+<?php
+/**
+ * Copyright 2016 Pinterest, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Ensures Python package requirements are sorted and unique.
+ */
+final class PythonRequirementsLinter extends ArcanistLinter {
+
+ const LINT_DUPLICATES = 1;
+ const LINT_UNSORTED = 2;
+
+ public function getInfoName() {
+ return 'Python requirements.txt Linter';
+ }
+
+ public function getInfoDescription() {
+ return pht('Ensures package requirements are sorted and unique.');
+ }
+
+ public function getInfoURI() {
+ return 'https://pip.readthedocs.org/en/latest/user_guide/#requirements-files';
+ }
+
+ public function getLinterName() {
+ return 'REQUIREMENTS-TXT';
+ }
+
+ public function getLinterConfigurationName() {
+ return 'requirements-txt';
+ }
+
+ public function getLintSeverityMap() {
+ return array(
+ self::LINT_DUPLICATES => ArcanistLintSeverity::SEVERITY_ERROR,
+ self::LINT_UNSORTED => ArcanistLintSeverity::SEVERITY_WARNING,
+ );
+ }
+
+ public function getLintNameMap() {
+ return array(
+ self::LINT_DUPLICATES => pht('Duplicate package requirement'),
+ self::LINT_UNSORTED => pht('Unsorted package requirement'),
+ );
+ }
+
+ private function lintDuplicates($lines) {
+ $packages = array();
+
+ foreach ($lines as $lineno => $line) {
+ if (empty($line) || $line[0] == '#' || $line[0] == '-') {
+ continue;
+ }
+
+ $package = strtolower(head(explode('==', $line)));
+ if (array_key_exists($package, $packages)) {
+ $first = $packages[$package];
+ $this->raiseLintAtLine(
+ $lineno + 1,
+ 0,
+ self::LINT_DUPLICATES,
+ pht(
+ 'This line contains a duplicate package requirement for "%s". '.
+ 'The first reference appears on line %d: "%s"',
+ $package, $first[0], $first[1]),
+ $package);
+ } else {
+ $packages[$package] = array($lineno + 1, $line);
+ }
+ }
+ }
+
+ private function lintUnsorted($lines) {
+ $last = null;
+
+ foreach ($lines as $lineno => $line) {
+ if (empty($line) || $line[0] == '#' || $line[0] == '-') {
+ continue;
+ }
+
+ $package = head(explode('==', $line));
+ if (strnatcasecmp($package, $last) <= 0) {
+ $this->raiseLintAtLine(
+ $lineno + 1,
+ 0,
+ self::LINT_UNSORTED,
+ pht(
+ "This line doesn't appear in sorted order. Please keep ".
+ "package requirements ordered alphabetically."));
+ }
+
+ $last = $package;
+ }
+ }
+
+ public function lintPath($path) {
+ $lines = phutil_split_lines($this->getData($path), false);
+ $lines = array_map('trim', $lines);
+
+ if ($this->isMessageEnabled(self::LINT_DUPLICATES)) {
+ $this->lintDuplicates($lines);
+ }
+ if ($this->isMessageEnabled(self::LINT_UNSORTED)) {
+ $this->lintUnsorted($lines);
+ }
+ }
+}

File Metadata

Mime Type
text/x-diff
Expires
Tue, Jul 8, 07:06 (8 h, 55 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
810367
Default Alt Text
(32 KB)

Event Timeline