ó '![c@@sìdZddlmZmZddlZddlZddlmZd„Zd„Z d„Z d„Z d „Z d „Z d efd „ƒYZd efd„ƒYZdefd„ƒYZdefd„ƒYZdefd„ƒYZdS(s'Utility methods for docstring checking.i(tabsolute_importtprint_functionN(tutilscC@st|ƒt|jdƒƒS(s„The number of leading spaces in a string :param str s: input string :rtype: int :return: number of leading spaces t (tlentlstrip(ts((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytspace_indentationscC@sp|jr|jjng}xN|D]F}t|tjƒr"|jdkr"t|jtjƒr"|jjSq"WdS(sGet the name of the property that the given node is a setter for. :param node: The node to get the property name for. :type node: str :rtype: str or None :returns: The name of the property that the node is a setter for, or None if one could not be found. tsetterN( t decoratorstnodest isinstancetastroidt AttributetattrnametexprtNametnametNone(tnodeR t decorator((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytget_setters_property_name#s  cC@spd}t|ƒ}tj|ƒ}|rl|rl|j|jƒ}x*|D]}tj|ƒrF|}PqFqFWn|S(s+Get the property node for the given setter node. :param node: The node to get the property for. :type node: astroid.FunctionDef :rtype: astroid.FunctionDef or None :returns: The node relating to the property of the given setter node, or None if one could not be found. N(RRRtnode_frame_classtgetattrRtdecorated_with_property(Rt property_t property_namet class_nodet class_attrstattr((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytget_setters_property6s     cC@s9|j}|dkrtSt|tjƒo7|jdk S(sCheck if a return node returns a value other than None. :param return_node: The return node to check. :type return_node: astroid.Return :rtype: bool :return: True if the return node returns a value other than None, False otherwise. N(tvalueRtFalseR R tConst(t return_nodetreturns((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytreturns_somethingNs  c@sÿg}tˆjtjƒrEtjˆjƒ}|rÂ|jg}qÂn}tˆjtjƒrJtˆjjtjƒrJtjˆjjƒ}t|tj ƒr¨|jg}qÂt|tj ƒrÂxŠ|j tj ƒD]s}|j ƒ|krëqÍntj|jƒ}|rÍt|tjtj fƒrÍtj|ƒrÍ|j|jƒqÍqÍWqÂnxˆjdkrˆj}x&|rŠt|tjƒ rŠ|j}qeW|rÂ|jrÂtj|jƒ}d„|Dƒ}qÂnyt‡fd†|DƒƒSWntjk rútƒSXdS(sZ Gets all of the possible raised exception types for the given raise node. .. note:: Caught exception types are ignored. :param node: The raise node to find exception types for. :type node: astroid.node_classes.NodeNG :returns: A list of exception types possibly raised by :param:`node`. :rtype: set(str) cs@s'|]}|tjk r|jVqdS(N(R t UninferableR(t.0texc((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pys Šsc3@s'|]}tjˆ|ƒs|VqdS(N(Rtnode_ignores_exception(R&R'(R(sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pys sN(R R'R RRt safe_inferRtCalltfunctClassDeft FunctionDeftnodes_of_classtReturntframeRtInstancetinherit_from_std_extappendRtparentt ExceptHandlerttypet unpack_infertsettInferenceError(Rtexcstinferredttargettrettvalthandlert inferred_excs((RsBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytpossible_exc_types`s:!  cC@sCx6ttttgD]"}||ƒ}|jƒr|SqWt|ƒS(N(tSphinxDocstringtEpytextDocstringtGoogleDocstringtNumpyDocstringtis_validt Docstring(t docstringtdocstring_typetinstance((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt docstringify”s    RGcB@s–eZejdejejBƒZd Zd„Z d„Z d„Z d„Z d„Z d„Zd„Zd„Zd „Zd „Zd „Zd „ZRS(s= For\s+the\s+(other)?\s*parameters\s*,\s+see cC@s|p d}|jƒ|_dS(Nt(t expandtabstdoc(tselfRN((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt__init__«s cC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRF¯scC@stƒS(N(R8(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt exceptions²scC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt has_paramsµscC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt has_returns¸scC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt has_rtype»scC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pythas_property_returns¾scC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pythas_property_typeÁscC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt has_yieldsÄscC@stS(N(R (RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pythas_yields_typeÇscC@stƒtƒfS(N(R8(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytmatch_param_docsÊscC@s|jj|jƒdk S(N(tre_for_parameters_seetsearchRNR(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytparams_documented_elsewhereÍsN(t__name__t __module__tretcompiletXtSRZRtsupports_yieldsRPRFRQRRRSRTRURVRWRXRYR\(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRGžs           RBcB@sYeZdZdjdeƒZdjeƒZdjdedeƒZejeej ej BƒZ djdeƒZ eje ej ej BƒZ djdeƒZejeej ej BƒZdjdeƒZejeej ej BƒZejd ƒZejd ƒZeZd „Zd „Zd „Zd„Zd„Zd„Zd„Zd„ZRS(s[\w\.]+s‰ {type} # a container type [\(\[] [^\n\s]+ [\)\]] # with the contents of the container R6sx (?::\w+:)? # optional tag `{0}` # what to reference sè : # initial colon (?: # Sphinx keywords param|parameter| arg|argument| key|keyword ) \s+ # whitespace (?: # optional type declaration ({type}|{container_type}) \s+ )? (\w+) # Parameter name \s* # whitespace : # final colon tcontainer_typesó :type # Sphinx keyword \s+ # whitespace ({type}) # Parameter name \s* # whitespace : # final colon sš :type: # Sphinx keyword \s+ # whitespace {type} # type declaration s´ : # initial colon (?: # Sphinx keyword raises?| except|exception ) \s+ # whitespace (?: # type declaration ({type}) \s+ )? (\w+) # Parameter name \s* # whitespace : # final colon s:rtype:s :returns?:cC@smt|jj|jƒpi|jj|jƒpi|jj|jƒpi|jj|jƒpi|jj|jƒƒS(N(tbooltre_param_in_docstringR[RNtre_raise_in_docstringtre_rtype_in_docstringtre_returns_in_docstringtre_property_type_in_docstring(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRFs cC@sLtƒ}x<tj|j|jƒD]"}|jdƒ}|j|ƒq"W|S(Ni(R8R_tfinditerRgRNtgrouptadd(ROttypestmatcht raise_type((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRQ$s  cC@s&|js tS|jj|jƒdk S(N(RNR RfR[R(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRR-s cC@s&|js tSt|jj|jƒƒS(N(RNR ReRiR[(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRS3s cC@s&|js tSt|jj|jƒƒS(N(RNR ReRhR[(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRT9s cC@s$|js tS|jjƒjdƒ S(Nt:(RNR Rt startswith(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRU?s cC@s&|js tSt|jj|jƒƒS(N(RNR ReRjR[(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRVGs cC@s¥tƒ}tƒ}xgtj|j|jƒD]M}|jdƒ}|j|ƒ|jdƒ}|dk r+|j|ƒq+q+W|jtj |j |jƒƒ||fS(Nii( R8R_RkRfRNRlRmRtupdatetfindalltre_type_in_docstring(ROtparams_with_doctparams_with_typeRoRt param_type((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRYMs    (R]R^tre_typetformattre_simple_container_typetre_xreft re_param_rawR_R`RaRbRft re_type_rawRutre_property_type_rawRjt re_raise_rawRgRhRiR RcRFRQRRRSRTRURVRY(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRBÑs.      RCcB@súeZdZejejjdddƒejej BƒZ ejej jdddƒejej BƒZ ejej jdddƒejej BƒZejejjdddƒejej BƒZejdejej BƒZejdƒZd„ZRS(s€ Epytext is similar to Sphinx. See the docs: http://epydoc.sourceforge.net/epytext.html http://epydoc.sourceforge.net/fields.html#fields It's used in PyCharm: https://www.jetbrains.com/help/pycharm/2016.1/creating-documentation-comments.html#d848203e314 https://www.jetbrains.com/help/pycharm/2016.1/using-docstrings-to-specify-types.html Rqt@is @ # initial "at" symbol (?: # Epytext keyword rtype|returntype ) : # final colon s @returns?:cC@s4|js tS|jƒr0|jjƒjdƒ StS(NR(RNR RVRRr(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRU€s   (R]R^t__doc__R_R`RBR}treplaceRaRbRfR~RuRRjR€RgRhRiRU(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRC\s" RDcB@sueZejZejZdjdedeƒZdjdededeƒZdZe j ejdƒe j e j Be j BƒZe j ejdƒe j e j Be j BƒZe j djdeƒe j e j Be j BƒZe j ejd ƒe j e j Be j BƒZe j d jdeƒe j e j Be j BƒZe j ejd ƒe j e j Be j BƒZe j d jdeƒe j e j Be j BƒZe j d jdeƒe j e j Be j BƒZe j ejdƒe j e j Be j BƒZeZeZd„Zd„Zd„Zd„Zd„Zd„Zd„Z d„Z!d„Z"d„Z#d„Z$e%d„ƒZ&d„Z'RS(s‰ (?:{type}|{xref}) # a container type [\(\[] [^\n]+ [\)\]] # with the contents of the container R6txrefsh (?:{container_type}|{type}|{xref}) (?:\s+or\s+(?:{container_type}|{type}|{xref}))* Rdsy ^([ ]*) {0} \s*: \s*$ # Google parameter header ( .* ) # section s(?:Args|Arguments|Parameters)s&Keyword\s(?:Args|Arguments|Parameters)s  \s* \*{{0,2}}(\w+) # identifier potentially with asterisks \s* ( [(] {type} [)] )? \s* : # optional type declaration \s* (.*) # beginning of optional description tRaisessˆ \s* ({type}) \s* : # identifier \s* (.*) # beginning of optional description sReturns?s \s* ({type}:)? # identifier \s* (.*) # beginning of description s~ ^{type}: # indentifier \s* (.*) # Summary line / description sYields?cC@spt|jj|jƒpl|jj|jƒpl|jj|jƒpl|jj|jƒpl|jj|jƒƒƒS(N( Retre_param_sectionR[RNtre_raise_sectiontre_returns_sectiontre_yields_sectiontre_property_returns_linet _first_line(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRFÛs cC@s&|js tS|jj|jƒdk S(N(RNR R†R[R(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRRâs cC@sk|js tS|j|jƒ}xE|D]=}|jj|ƒ}|sJq&n|jdƒ}|r&tSq&WtS(Ni(RNR t_parse_sectionRˆtre_returns_lineRoRltTrue(ROtentriestentryRot return_desc((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRSès  cC@sk|js tS|j|jƒ}xE|D]=}|jj|ƒ}|sJq&n|jdƒ}|r&tSq&WtS(Ni(RNR RŒRˆRRoRlRŽ(RORRRot return_type((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRTøs  cC@sY|jƒ}t|jj|ƒpT|jj|ƒpT|jj|ƒpT|jj|ƒƒ S(N(R‹ReR†R[R‡RˆR‰(ROt first_line((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRUs  cC@s)|js tSt|jj|jƒƒƒS(N(RNR ReRŠRoR‹(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRVs cC@sk|js tS|j|jƒ}xE|D]=}|jj|ƒ}|sJq&n|jdƒ}|r&tSq&WtS(Ni(RNR RŒR‰tre_yields_lineRoRlRŽ(RORRRot yield_desc((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRWs  cC@sk|js tS|j|jƒ}xE|D]=}|jj|ƒ}|sJq&n|jdƒ}|r&tSq&WtS(Ni(RNR RŒR‰R”RoRlRŽ(RORRRot yield_type((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRX's  cC@s‚tƒ}|j|jƒ}x`|D]X}|jj|ƒ}|sFq"n|jdƒ}|jdƒ}|r"|j|ƒq"q"W|S(Nii(R8RŒR‡t re_raise_lineRoRlRm(RORnRRRotexc_typetexc_desc((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRQ7s  c C@sÏtƒ}tƒ}|j|jƒ}|j|j|jƒƒx…|D]}}|jj|ƒ}|shqDn|jdƒ}|jdƒ}|jdƒ}|r«|j|ƒn|rD|j|ƒqDqDW||fS(Niii( R8RŒR†textendtre_keyword_param_sectiont re_param_lineRoRlRm( RORvRwRRRot param_nameRxt param_desc((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRYGs    cC@s|jjƒjddƒdS(Ns ii(RNRtsplit(RO((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyR‹]scC@st|jdƒƒdS(Ni(RRl(t section_match((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pytmin_section_indent`sc C@s |j|jƒ}|dkr"gS|j|ƒ}g}g}t}x¡|jdƒjƒD]Š}|jƒsqqYnt|ƒ}||krPn|r¢|}t }n||krÖ|rÖ|j dj |ƒƒg}qÖn|j |ƒqYW|r|j dj |ƒƒn|S(Nis ( R[RNRR¡RŽRlt splitlineststripRR R3tjoin( ROt section_reR tmin_indentationRRtis_firsttlinet indentation((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRŒds0       ((R]R^RBRyR|Rztre_container_typetre_multiple_typet_re_section_templateR_R`RaRbtMR†R›RœR‡R—RˆRRŠR‰R”RŽRcRFRRRSRTRURVRWRXRQRYR‹t staticmethodR¡RŒ(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyRDsb      )              REcB@sheZdZejejdƒejejBejBƒZ ejdjde j ƒejejBƒZ ejejdƒejejBejBƒZ ejdjde jƒejejBejBƒZejejdƒejejBejBƒZejdjde j ƒejejBejBƒZejejdƒejejBejBƒZeZeZed „ƒZRS( sª ^([ ]*) {0} \s*?$ # Numpy parameters header \s* [-=]+ \s*?$ # underline ( .* ) # section s(?:Args|Arguments|Parameters)s \s* (\w+) # identifier \s* : \s* (?:({type})(?:,\s+optional)?)? # optional type declaration \n # description starts on a new line \s* (.*) # description R6R…s_ \s* ({type})$ # type declaration \s* (.*) # optional description sReturns?sl \s* ({type})$ # type declaration \s* (.*) # optional description sYields?cC@st|jdƒƒS(Ni(RRl(R ((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyR¡¿s(R]R^R¬R_R`RzRaRbR­R†RDR«RœR‡RyR—RˆRR‰R”RŽRcR®R¡(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyREŠs4    ,    (R‚t __future__RRR_R tpylint.checkersRRRRR$RARKtobjectRGRBRCRDRE(((sBlib/python2.7/site-packages/pylint/extensions/_check_docs_utils.pyt s      4 3‹1ý