Add documentation for configuration about pyre-check

[dkgi]

Unfortunately the documentation is not quite there yet. @shannonzhu is currently working on documenting the configuration. We'll keep you posted :)

[Ameobea]

Awesome; thanks for the cool tool!

[dkgi]

Configuration can be found here: https://pyre-check.org/docs/configuration.html
Let us know if we missed something :)

[rpgoldman]

@dkgi It would be helpful if you could explain how search path could be initialized in the pyre configuration file. I am using it successfully as a command line option (--search-path) but haven't figured out its use in the configuration file. In particular, what data type is a SEARCH_PATH? A pathname? a list of pathnames? Thanks!

[dark]

@rpgoldman
search_path is a list of pathnames:

{                                                  
  "search_path" : ["/some/directory", "/some/other/directory"]                                  
}

[rpgoldman]

For some reason that isn't working for me. When I try to use the following configuration file, pyre does not see the stubs I have put in /Users/rpg/projects/xplan/yeast-gates-data/stubs/, but when I pass that directory using --search-path, it does. Any idea why not? Could the autogenerated configuration option interfere with search-path?

$ cat .pyre_configuration 
{
  "binary": "/Users/rpg/Library/Python/3.7/bin/pyre.bin",
  "source_directories": [
    "."
  ],
  "typeshed": "/Users/rpg/Library/Python/3.7/lib/pyre_check/typeshed/",
  "autogenerated": ["/Users/rpg/projects/xplan/yeast-gates-data/Charts/",
                    "/Users/rpg/projects/xplan/yeast-gates-data/Model2.0/",
                    "/Users/rpg/projects/xplan/yeast-gates-data/Models/",
                    "/Users/rpg/projects/xplan/yeast-gates-data/.mypy_cache/",
                    "/Users/rpg/projects/xplan/yeast-gates-dataprior/",
                    "/Users/rpg/projects/xplan/yeast-gates-data/pymc3-data/",
                    "/Users/rpg/projects/xplan/yeast-gates-data/stubs/"],
   "search-path": ["/Users/rpg/projects/xplan/yeast-gates-data/stubs/"]
}rpg@RPG-MacBook-Pro: ~/projects/xplan/yeast-gates-data $ ls /Users/rpg/projects/xplan/yeast-gates-data/stubs/
FlowCytometryTools/  numpy@  pymc3@

[dark]

The config item is search_path not search-path :)

[rpgoldman]

Thanks! As a long-time lisp user (Emacs and Common), that is not a surprising mistake for me to make. But the command-line option works with the hyphen instead of an underscore: you might want to remark on this in the configuration docs.

[dark]

It's a mistake that happens more often than you'd expect :) 4d0e797 added some code to warn when a configuration item is not recognized, but we haven't published a new release since. Maybe it's time I push that button.