Add files via upload

Author: zham411

CHANGELOG.md

@@ -0,0 +1,19 @@
+Copyright (c) 2014 pre-commit dev team: Anthony Sottile, Ken Struys
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

LICENSE

@@ -0,0 +1,192 @@
+[![Build Status](https://asottile.visualstudio.com/asottile/_apis/build/status/pre-commit.pre-commit-hooks?branchName=master)](https://asottile.visualstudio.com/asottile/_build/latest?definitionId=17&branchName=master)
+[![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/asottile/asottile/17/master.svg)](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=17&branchName=master)
+
+pre-commit-hooks
+================
+
+Some out-of-the-box hooks for pre-commit.
+
+See also: https://github.com/pre-commit/pre-commit
+
+
+### Using pre-commit-hooks with pre-commit
+
+Add this to your `.pre-commit-config.yaml`
+
+```yaml
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0  # Use the ref you want to point at
+    hooks:
+    -   id: trailing-whitespace
+    # -   id: ...
+```
+
+### Hooks available
+
+#### `check-added-large-files`
+Prevent giant files from being committed.
+  - Specify what is "too large" with `args: ['--maxkb=123']` (default=500kB).
+  - Limits checked files to those indicated as staged for addition by git.
+  - If `git-lfs` is installed, lfs files will be skipped
+    (requires `git-lfs>=2.2.1`)
+  - `--enforce-all` - Check all listed files not just those staged for
+    addition.
+
+#### `check-ast`
+Simply check whether files parse as valid python.
+
+#### `check-builtin-literals`
+Require literal syntax when initializing empty or zero Python builtin types.
+  - Allows calling constructors with positional arguments (e.g., `list('abc')`).
+  - Allows calling constructors from the `builtins` (`__builtin__`) namespace (`builtins.list()`).
+  - Ignore this requirement for specific builtin types with `--ignore=type1,type2,…`.
+  - Forbid `dict` keyword syntax with `--no-allow-dict-kwargs`.
+
+#### `check-case-conflict`
+Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
+
+#### `check-docstring-first`
+Checks for a common error of placing code before the docstring.
+
+#### `check-executables-have-shebangs`
+Checks that non-binary executables have a proper shebang.
+
+#### `check-json`
+Attempts to load all json files to verify syntax.
+
+#### `check-merge-conflict`
+Check for files that contain merge conflict strings.
+
+#### `check-symlinks`
+Checks for symlinks which do not point to anything.
+
+#### `check-toml`
+Attempts to load all TOML files to verify syntax.
+
+#### `check-vcs-permalinks`
+Ensures that links to vcs websites are permalinks.
+
+#### `check-xml`
+Attempts to load all xml files to verify syntax.
+
+#### `check-yaml`
+Attempts to load all yaml files to verify syntax.
+  - `--allow-multiple-documents` - allow yaml files which use the
+    [multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML)
+  - `--unsafe` - Instead of loading the files, simply parse them for syntax.
+    A syntax-only check enables extensions and unsafe constructs which would
+    otherwise be forbidden.  Using this option removes all guarantees of
+    portability to other yaml implementations.
+    Implies `--allow-multiple-documents`.
+
+#### `debug-statements`
+Check for debugger imports and py37+ `breakpoint()` calls in python source.
+
+#### `detect-aws-credentials`
+Checks for the existence of AWS secrets that you have set up with the AWS CLI.
+The following arguments are available:
+- `--credentials-file CREDENTIALS_FILE` - additional AWS CLI style
+  configuration file in a non-standard location to fetch configured
+  credentials from. Can be repeated multiple times.
+- `--allow-missing-credentials` - Allow hook to pass when no credentials are detected.
+
+#### `detect-private-key`
+Checks for the existence of private keys.
+
+#### `double-quote-string-fixer`
+This hook replaces double quoted strings with single quoted strings.
+
+#### `end-of-file-fixer`
+Makes sure files end in a newline and only a newline.
+
+#### `fix-byte-order-marker`
+removes UTF-8 byte order marker
+
+#### `fix-encoding-pragma`
+Add `# -*- coding: utf-8 -*-` to the top of python files.
+  - To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
+
+#### `file-contents-sorter`
+Sort the lines in specified files (defaults to alphabetical).
+You must provide list of target files as input to it.
+Note that this hook WILL remove blank lines and does NOT respect any comments.
+
+#### `forbid-new-submodules`
+Prevent addition of new git submodules.
+
+#### `mixed-line-ending`
+Replaces or checks mixed line ending.
+  - `--fix={auto,crlf,lf,no}`
+      - `auto` - Replaces automatically the most frequent line ending. This is the default argument.
+      - `crlf`, `lf` - Forces to replace line ending by respectively CRLF and LF.
+          - This option isn't compatible with git setup check-in LF check-out CRLF as git smudge this later than the hook is invoked.
+      - `no` - Checks if there is any mixed line ending without modifying any file.
+
+#### `name-tests-test`
+Assert that files in tests/ end in `_test.py`.
+  - Use `args: ['--django']` to match `test*.py` instead.
+
+#### `no-commit-to-branch`
+Protect specific branches from direct checkins.
+  - Use `args: [--branch, staging, --branch, master]` to set the branch.
+    `master` is the default if no branch argument is set.
+  - `-b` / `--branch` may be specified multiple times to protect multiple
+    branches.
+  - `-p` / `--pattern` can be used to protect branches that match a supplied regex
+    (e.g. `--pattern, release/.*`). May be specified multiple times.
+
+Note that `no-commit-to-branch` is configured by default to [`always_run`](https://pre-commit.com/#config-always_run).
+As a result, it will ignore any setting of [`files`](https://pre-commit.com/#config-files),
+[`exclude`](https://pre-commit.com/#config-exclude), [`types`](https://pre-commit.com/#config-types)
+or [`exclude_types`](https://pre-commit.com/#config-exclude_types).
+Set [`always_run: false`](https://pre-commit.com/#config-always_run) to allow this hook to be skipped according to these
+file filters. Caveat: In this configuration, empty commits (`git commit --allow-empty`) would always be allowed by this hook.
+
+#### `pretty-format-json`
+Checks that all your JSON files are pretty.  "Pretty"
+here means that keys are sorted and indented.  You can configure this with
+the following commandline options:
+  - `--autofix` - automatically format json files
+  - `--indent ...` - Control the indentation (either a number for a number of spaces or a string of whitespace).  Defaults to 2 spaces.
+  - `--no-ensure-ascii` preserve unicode characters instead of converting to escape sequences
+  - `--no-sort-keys` - when autofixing, retain the original key ordering (instead of sorting the keys)
+  - `--top-keys comma,separated,keys` - Keys to keep at the top of mappings.
+
+#### `requirements-txt-fixer`
+Sorts entries in requirements.txt and removes incorrect entry for `pkg-resources==0.0.0`
+
+#### `sort-simple-yaml`
+Sorts simple YAML files which consist only of top-level
+keys, preserving comments and blocks.
+
+Note that `sort-simple-yaml` by default matches no `files` as it enforces a
+very specific format.  You must opt in to this by setting [`files`](https://pre-commit.com/#config-files), for example:
+
+```yaml
+    -   id: sort-simple-yaml
+        files: ^config/simple/
+```
+
+
+#### `trailing-whitespace`
+Trims trailing whitespace.
+  - To preserve Markdown [hard linebreaks](https://github.github.com/gfm/#hard-line-break)
+    use `args: [--markdown-linebreak-ext=md]` (or other extensions used
+    by your markdownfiles).  If for some reason you want to treat all files
+    as markdown, use `--markdown-linebreak-ext=*`.
+  - By default, this hook trims all whitespace from the ends of lines.
+    To specify a custom set of characters to trim instead, use `args: [--chars,"<chars to trim>"]`.
+
+### Deprecated / replaced hooks
+
+- `autopep8-wrapper`: instead use
+  [mirrors-autopep8](https://github.com/pre-commit/mirrors-autopep8)
+- `pyflakes`: instead use `flake8`
+- `flake8`: instead use [upstream flake8](https://gitlab.com/pycqa/flake8)
+- `check-byte-order-marker`: instead use fix-byte-order-marker
+
+### As a standalone package
+
+If you'd like to use these hooks, they're also available as a standalone package.
+
+Simply `pip install pre-commit-hooks`

README.md

@@ -0,0 +1,24 @@
+trigger:
+  branches:
+    include: [master, test-me-*]
+  tags:
+    include: ['*']
+
+resources:
+  repositories:
+    - repository: asottile
+      type: github
+      endpoint: github
+      name: asottile/azure-pipeline-templates
+      ref: refs/tags/v1.0.0
+
+jobs:
+- template: job--pre-commit.yml@asottile
+- template: job--python-tox.yml@asottile
+  parameters:
+    toxenvs: [py38]
+    os: windows
+- template: job--python-tox.yml@asottile
+  parameters:
+    toxenvs: [pypy3, py36, py37, py38]
+    os: linux

azure-pipelines.yml

@@ -0,0 +1,70 @@
+import argparse
+import json
+import math
+import os
+from typing import Optional
+from typing import Sequence
+from typing import Set
+
+from pre_commit_hooks.util import added_files
+from pre_commit_hooks.util import CalledProcessError
+from pre_commit_hooks.util import cmd_output
+
+
+def lfs_files() -> Set[str]:
+    try:
+        # Introduced in git-lfs 2.2.0, first working in 2.2.1
+        lfs_ret = cmd_output('git', 'lfs', 'status', '--json')
+    except CalledProcessError:  # pragma: no cover (with git-lfs)
+        lfs_ret = '{"files":{}}'
+
+    return set(json.loads(lfs_ret)['files'])
+
+
+def find_large_added_files(
+        filenames: Sequence[str],
+        maxkb: int,
+        *,
+        enforce_all: bool = False,
+) -> int:
+    # Find all added files that are also in the list of files pre-commit tells
+    # us about
+    retv = 0
+    filenames_filtered = set(filenames) - lfs_files()
+    if not enforce_all:
+        filenames_filtered &= added_files()
+
+    for filename in filenames_filtered:
+        kb = int(math.ceil(os.stat(filename).st_size / 1024))
+        if kb > maxkb:
+            print(f'{filename} ({kb} KB) exceeds {maxkb} KB.')
+            retv = 1
+
+    return retv
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        'filenames', nargs='*',
+        help='Filenames pre-commit believes are changed.',
+    )
+    parser.add_argument(
+        '--enforce-all', action='store_true',
+        help='Enforce all files are checked, not just staged files.',
+    )
+    parser.add_argument(
+        '--maxkb', type=int, default=500,
+        help='Maxmimum allowable KB for added files',
+    )
+    args = parser.parse_args(argv)
+
+    return find_large_added_files(
+        args.filenames,
+        args.maxkb,
+        enforce_all=args.enforce_all,
+    )
+
+
+if __name__ == '__main__':
+    exit(main())

check_added_large_files.py

@@ -0,0 +1,32 @@
+import argparse
+import ast
+import platform
+import sys
+import traceback
+from typing import Optional
+from typing import Sequence
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filenames', nargs='*')
+    args = parser.parse_args(argv)
+
+    retval = 0
+    for filename in args.filenames:
+
+        try:
+            with open(filename, 'rb') as f:
+                ast.parse(f.read(), filename=filename)
+        except SyntaxError:
+            impl = platform.python_implementation()
+            version = sys.version.split()[0]
+            print(f'{filename}: failed parsing with {impl} {version}:')
+            tb = '    ' + traceback.format_exc().replace('\n', '\n    ')
+            print(f'\n{tb}')
+            retval = 1
+    return retval
+
+
+if __name__ == '__main__':
+    exit(main())