way to probe bears for needed settings about coala HOT 11 CLOSED

@smfn3321 waiting for your opinion here

from coala.

@cw1 your's is valued too

from coala.

This would solve how the use finds out about what the bear is capable of so I'm in favor of it. I'm actually thinking about redesigning our bear architecture a bit. Imagine a bear developer could just write his object as:

class SpaceConsistencyBear(LocalBear):
    def run_bear(self, filename, file, tab_width, allow_trailing_spaces=False):
        pass  # ok we'll want to do something here but thats irrelevant for this example

We then could analyze the signature of this function with inspect.getfullargspec(some_bear.run_bear), thus we could get the settings for the bear and he doesn't have to deal with the settings dict. Furthermore we can extrapolate the needed settings (which is the names of the parameters after, excluding, file) and the minimal_needed_settings. Maybe we could even get a help text from the documentation comment.

from coala.

Your last comment sounds good. Is this the way we can produce a help massage for the user for any giving bear? What kind of syntax would you like to prefer for the documentation comment?

from coala.

usual doc comment like we use all day long in coala.

from coala.

first draft of documentation parser is here: https://github.com/sils1297/coala/blob/wip/extract_needed_params/coalib/parsing/DocumentationCommentParser.py
I'm open to suggestions for simplifications.

from coala.

interesting:

>>> def test(var1, var2: test="t"):
...   pass
... 
>>> getfullargspec(test)
FullArgSpec(args=['var1', 'var2'], varargs=None, varkw=None, defaults=('t',), kwonlyargs=[], kwonlydefaults=None, annotations={'var2': <function test at 0x7f5c45a6fc80>})

from coala.

it works:

>>> from coalib.settings.FunctionMetadata import FunctionMetadata
>>> def test(p1, p2="test", p3=5):
...   """
...   tests something
... 
...   :param p2: its a test value
...   :return nothing.
...   """
...   pass
... 
>>> fm=FunctionMetadata.from_function(
... test)
>>> fm.name
'test'
>>> fm.desc
'tests something'
>>> fm.retval_desc
'nothing.'
>>> fm.non_optional_params
{'p1': 'No description given.'}
>>> fm.optional_params
{'p2': "its a test value (Optional, defaults to 'test'.)", 'p3': "No description given. (Optional, defaults to '5'.)"}

from coala.

began implementation on #150

from coala.

we now have this implemented in the SettingsCreatable, will migrate this to the bears soon. However we'll need code duplication avoidance strategies for this, I don't wanna copy it.

from coala.

lasse@lsmobfed21 ~/prog/gnome/srcn/gnome-boxes (git)-[master] % coala
Please enter a value for the setting "UseSpaces" (('True if spaces are to be used instead of tabs.', <class 'bool'>)) needed by SpaceConsistencyBear:

Works on #150. Outputter needs to be adjusted a bit though but Fabians creating the ConsoleOutputter from scratch anyway.

from coala.