Adds a pysa quick start command: init-pya #506

abishekvashok · 2021-10-11T14:46:21Z

Adds a pysa quick command: init-pysa, that helps users setup a suitable
environment to run pysa. It handles commonly found issues in pysa and
creates the best possible environment while handling some of the edge
cases.

Test Plan

create (or enter into the directory of) a python project you'd like to run pysa on
install pyre from source (see installation docs) (suitably create an alias for the client)
run pyre init-pysa

Preview:

Signed-off-by: Abishek V Ashok abishekvashok@gmail.com
Fixes: MLH-Fellowship#80

abishekvashok · 2021-10-11T14:56:31Z

Can affirm linters and pyre are failing not due to these changes.

facebook-github-bot · 2021-10-11T16:57:38Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

0xedward

Awesome, thanks for working on this! I'm excited for this, since it'll help new users get set up with Pysa faster.

I had a few questions and suggestions

tools/pysa_quickstart/quickstart.py

facebook-github-bot · 2021-10-12T12:33:48Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

facebook-github-bot · 2021-10-12T12:33:59Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-12T12:35:39Z

@0xedward made the requested changes! Thanks for taking time to review this!

facebook-github-bot · 2021-10-12T19:16:09Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

0xedward

Thanks for making the changes! Would you be able to fix some of the flake8 linter errors? :)

It looks like our open source config for flake8 is missing the lines our internal config of flake8 is catching. Would you be able to fix all the lines causing B950 lint error when running flake8 locally?

tools/pysa_quickstart/quickstart.py

facebook-github-bot · 2021-10-13T07:15:29Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

facebook-github-bot · 2021-10-13T07:16:55Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-13T07:18:12Z

@0xedward removed the unused import. Sorry I missed that somehow. With the open source config, I tried including B950 explicitly with select and tried removing some conflicting rules, but couldn't reproduce any B950s but managed to make sure every line is below 88 in length (which is kinda what B950 specifies ig), but still we should mirror the internal config for flake8 and maybe should fix the linters as well in another PR.

facebook-github-bot · 2021-10-13T18:31:58Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

0xedward · 2021-10-13T18:35:16Z

With the open source config, I tried including B950 explicitly with select and tried removing some conflicting rules, but couldn't reproduce any B950s but managed to make sure every line is below 88 in length (which is kinda what B950 specifies ig), but still we should mirror the internal config for flake8 and maybe should fix the linters as well in another PR.

@abishekvashok - ah no problem! That makes sense, because the Github actions lint run for flake8 also didn't show any of those errors. If there any other issues, I'll fix them and merge this PR.

Let's look into mirror our internal linter setup afterwards :)

arthaud · 2021-10-14T17:55:08Z

Everything we are doing here seems like things most python projects would want to do. Is there a tool that could do this for us?
Also, are we expecting our users to git clone our repo and run that script? That seems higher entry than just pip install pyre + pyre init.
Do we want something like opam init that installs everything and puts something in the .bashrc? I find it annoying to have to enter a virtualenv everytime I want to use pyre/pysa. Also, it has the side effect of adding random python stuff in your environment. Most people don't want that.

abishekvashok · 2021-10-15T08:18:47Z

Do we want something like opam init that installs everything and puts something in the .bashrc?

That is a good direction for us to tweak this towards.

facebook-github-bot · 2021-10-18T08:21:29Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-18T08:21:39Z

Changed the script to be a command :)

facebook-github-bot · 2021-10-18T16:17:08Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

client/pyre.py

client/commands/v2/init_pysa.py

facebook-github-bot · 2021-10-20T05:44:07Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-20T05:44:37Z

@arthaud thank you for the suggestions, and sorry for messing up a bit. But it's fixed now :)

facebook-github-bot · 2021-10-20T18:14:16Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

abishekvashok · 2021-10-20T18:25:17Z

Haven't touched any python files to cause pyre to break :)

client/commands/v2/initialize_pysa.py

facebook-github-bot · 2021-10-21T14:24:29Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-21T14:24:54Z

@0xedward done :)

NB: Pyre is complaining about files not related to the PR.

facebook-github-bot · 2021-10-21T16:39:25Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

client/commands/v2/initialize_pysa.py

client/pyre.py

facebook-github-bot · 2021-10-22T06:57:56Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-22T06:58:23Z

@arthaud done :)

facebook-github-bot · 2021-10-22T15:39:50Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

client/pyre.py

Adds a pysa quick start command that helps users setup a suitable environment to run pysa. It handles commonly found issues in pysa and creates the best possible environment while handling even the edge case scenarios. Signed-off-by: Abishek V Ashok <abishekvashok@gmail.com>

facebook-github-bot · 2021-10-22T18:33:24Z

@abishekvashok has updated the pull request. You must reimport the pull request before landing.

abishekvashok · 2021-10-22T18:34:01Z

I am amazed why flake8 couldn't detect the unused variable

facebook-github-bot · 2021-10-25T15:07:27Z

@0xedward has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

facebook-github-bot · 2021-10-25T21:00:14Z

@0xedward merged this pull request in e7d5d75.

gbleaney · 2021-10-25T21:11:55Z

Thanks for landing this! @abishekvashok would you also be able to update the quickstart docs to reference this?
https://pyre-check.org/docs/pysa-quickstart
https://github.com/facebook/pyre-check/blob/main/documentation/website/docs/pysa_quickstart.md

abishekvashok · 2021-10-26T01:53:46Z

@gbleaney sure :)

abishekvashok · 2021-10-26T15:06:28Z

@gbleaney sorry if it took a bit of time, but #519 :)

gbleaney · 2021-10-26T18:18:48Z

@abishekvashok ha! I consider < 24 hours very fast :)

abishekvashok force-pushed the quickstart-automation branch 2 times, most recently from da4fb38 to 5b4894d Compare October 11, 2021 14:55

0xedward requested changes Oct 11, 2021

View reviewed changes

abishekvashok force-pushed the quickstart-automation branch from 5b4894d to 28c2ad8 Compare October 12, 2021 12:33

abishekvashok force-pushed the quickstart-automation branch from 28c2ad8 to 98012fe Compare October 12, 2021 12:33

0xedward requested changes Oct 13, 2021

View reviewed changes

tools/pysa_quickstart/quickstart.py Outdated Show resolved Hide resolved

abishekvashok force-pushed the quickstart-automation branch from 98012fe to 665205c Compare October 13, 2021 07:15

abishekvashok force-pushed the quickstart-automation branch from 665205c to f480c57 Compare October 13, 2021 07:16

facebook-github-bot added the CLA Signed label Oct 13, 2021

abishekvashok force-pushed the quickstart-automation branch from f480c57 to c5e8fda Compare October 18, 2021 08:21

arthaud requested changes Oct 18, 2021

View reviewed changes

abishekvashok force-pushed the quickstart-automation branch from c5e8fda to abcf215 Compare October 20, 2021 05:44

0xedward requested changes Oct 20, 2021

View reviewed changes

client/commands/v2/initialize_pysa.py Show resolved Hide resolved

client/commands/v2/initialize_pysa.py Outdated Show resolved Hide resolved

client/commands/v2/initialize_pysa.py Outdated Show resolved Hide resolved

abishekvashok force-pushed the quickstart-automation branch from abcf215 to 508e570 Compare October 21, 2021 14:24

arthaud requested changes Oct 21, 2021

View reviewed changes

abishekvashok changed the title ~~Adds a pysa quick start script~~ Adds a pysa quick start command: init-pya Oct 22, 2021

abishekvashok force-pushed the quickstart-automation branch from 508e570 to 95d81a6 Compare October 22, 2021 06:57

arthaud requested changes Oct 22, 2021

View reviewed changes

client/pyre.py Outdated Show resolved Hide resolved

abishekvashok force-pushed the quickstart-automation branch from 95d81a6 to 2104ed2 Compare October 22, 2021 18:33

abishekvashok requested review from arthaud and 0xedward October 22, 2021 18:33

facebook-github-bot closed this in e7d5d75 Oct 25, 2021

facebook-github-bot added the Merged label Oct 25, 2021

Adds a pysa quick start command: init-pya #506

Adds a pysa quick start command: init-pya #506

Conversation

abishekvashok commented Oct 11, 2021 • edited

abishekvashok commented Oct 11, 2021

facebook-github-bot commented Oct 11, 2021

0xedward left a comment

Choose a reason for hiding this comment

facebook-github-bot commented Oct 12, 2021

facebook-github-bot commented Oct 12, 2021

abishekvashok commented Oct 12, 2021

facebook-github-bot commented Oct 12, 2021

0xedward left a comment

Choose a reason for hiding this comment

facebook-github-bot commented Oct 13, 2021

facebook-github-bot commented Oct 13, 2021

abishekvashok commented Oct 13, 2021 • edited

facebook-github-bot commented Oct 13, 2021

0xedward commented Oct 13, 2021

arthaud commented Oct 14, 2021

abishekvashok commented Oct 15, 2021

facebook-github-bot commented Oct 18, 2021

abishekvashok commented Oct 18, 2021

facebook-github-bot commented Oct 18, 2021

facebook-github-bot commented Oct 20, 2021

abishekvashok commented Oct 20, 2021

facebook-github-bot commented Oct 20, 2021

abishekvashok commented Oct 20, 2021

facebook-github-bot commented Oct 21, 2021

abishekvashok commented Oct 21, 2021

facebook-github-bot commented Oct 21, 2021

facebook-github-bot commented Oct 22, 2021

abishekvashok commented Oct 22, 2021

facebook-github-bot commented Oct 22, 2021

facebook-github-bot commented Oct 22, 2021

abishekvashok commented Oct 22, 2021

facebook-github-bot commented Oct 25, 2021

facebook-github-bot commented Oct 25, 2021

gbleaney commented Oct 25, 2021

abishekvashok commented Oct 26, 2021

abishekvashok commented Oct 26, 2021

gbleaney commented Oct 26, 2021

abishekvashok commented Oct 11, 2021 •

edited

abishekvashok commented Oct 13, 2021 •

edited