tooling: add black and flake8 for python formatting/linting (#6454)

This commit is contained in:
Matthew Peveler
2021-09-03 15:17:51 +00:00
committed by GitHub
parent f4390b1637
commit 3fa29ea1c2
7 changed files with 188 additions and 123 deletions

View File

@@ -5,9 +5,9 @@ import os
import sys
import requests
BOT_URL = 'https://tldr-bot.starbeamrainbowlabs.com'
BOT_URL = "https://tldr-bot.starbeamrainbowlabs.com"
COMMENT_ERROR="""
COMMENT_ERROR = """
The [build](https://github.com/tldr-pages/tldr/actions/runs/{build_id}) for this PR failed with the following error(s):
```
@@ -17,7 +17,7 @@ The [build](https://github.com/tldr-pages/tldr/actions/runs/{build_id}) for this
Please fix the error(s) and push again.
"""
COMMENT_CHECK="""
COMMENT_CHECK = """
Hello! I've noticed something unusual when checking this PR:
{content}
@@ -27,62 +27,69 @@ Is this intended? If so, just ignore this comment. Otherwise, please double-chec
################################################################################
def post_comment(pr_id, body, once):
endpoint = BOT_URL + '/comment'
endpoint = BOT_URL + "/comment"
if once:
endpoint += '/once'
if once:
endpoint += "/once"
data = {'pr_id': pr_id, 'body': body}
data = {"pr_id": pr_id, "body": body}
try:
with requests.post(endpoint, json=data) as r:
if r.status_code != requests.codes.ok:
print('Error: tldr-bot responded with code', r.status_code, file=sys.stderr)
print(r.text, file=sys.stderr)
try:
with requests.post(endpoint, json=data) as r:
if r.status_code != requests.codes.ok:
print(
"Error: tldr-bot responded with code",
r.status_code,
file=sys.stderr,
)
print(r.text, file=sys.stderr)
return False
except requests.exceptions.RequestException as e:
print("Error sending data to tldr-bot:", str(e), file=sys.stderr)
return False
except requests.exceptions.RequestException as e:
print('Error sending data to tldr-bot:', str(e), file=sys.stderr)
return False
return True
return True
def main(action):
if action not in ('report-errors', 'report-check-results'):
print('Unknown action:', action, file=sys.stderr)
sys.exit(1)
if action not in ("report-errors", "report-check-results"):
print("Unknown action:", action, file=sys.stderr)
sys.exit(1)
content = sys.stdin.read().strip()
content = sys.stdin.read().strip()
if action == 'report-errors':
comment_body = COMMENT_ERROR.format(build_id=BUILD_ID, content=content)
comment_once = False
elif action == 'report-check-results':
comment_body = COMMENT_CHECK.format(content=content)
comment_once = True
if action == "report-errors":
comment_body = COMMENT_ERROR.format(build_id=BUILD_ID, content=content)
comment_once = False
elif action == "report-check-results":
comment_body = COMMENT_CHECK.format(content=content)
comment_once = True
if post_comment(PR_ID, comment_body, comment_once):
print("Success.")
else:
print("Error sending data to tldr-bot!", file=sys.stderr)
if post_comment(PR_ID, comment_body, comment_once):
print('Success.')
else:
print('Error sending data to tldr-bot!', file=sys.stderr)
################################################################################
if __name__ == '__main__':
REPO_SLUG = os.environ.get('GITHUB_REPOSITORY')
PR_ID = os.environ.get('PULL_REQUEST_ID')
BUILD_ID = os.environ.get('GITHUB_RUN_ID')
if __name__ == "__main__":
REPO_SLUG = os.environ.get("GITHUB_REPOSITORY")
PR_ID = os.environ.get("PULL_REQUEST_ID")
BUILD_ID = os.environ.get("GITHUB_RUN_ID")
if PR_ID is None or BUILD_ID is None or REPO_SLUG is None:
print('Needed environment variables are not set.', file=sys.stderr)
sys.exit(1)
if PR_ID is None or BUILD_ID is None or REPO_SLUG is None:
print("Needed environment variables are not set.", file=sys.stderr)
sys.exit(1)
if PR_ID is None or PR_ID == 'false':
print('Not a pull request, refusing to run.', file=sys.stderr)
sys.exit(0)
if PR_ID is None or PR_ID == "false":
print("Not a pull request, refusing to run.", file=sys.stderr)
sys.exit(0)
if len(sys.argv) != 2:
print('Usage:', sys.argv[0], '<ACTION>', file=sys.stderr)
sys.exit(1)
if len(sys.argv) != 2:
print("Usage:", sys.argv[0], "<ACTION>", file=sys.stderr)
sys.exit(1)
main(sys.argv[1])
main(sys.argv[1])