U ehO!@sUddlZddlZddlZddlmZddlmZddlmZddl m Z m Z ddl m Z eeZee ZedZeed<ed Zeed <ed Zeed <ed Zeed<dZdZdZdZeddddgZGdddZdS)N) namedtuple)Pattern)Faker)AVAILABLE_LOCALESDEFAULT_LOCALE)SampleCodeValidatorz1^faker\.providers\.BaseProvider\.(?P\w+)$_base_provider_method_patternz2^faker\.providers\.\w+\.Provider\.(?P\w+)$!_standard_provider_method_patternzS^faker\.providers\.\w+\.(?P[a-z]{2,3}_[A-Z]{2})\.Provider\.(?P\w+)$_locale_provider_method_patternzZ^:sample(?: size=(?P[1-9][0-9]*))?(?: seed=(?P[0-9]+))?:(?: ?(?P.*))?$_sample_line_patternzgenerator.{method}({kwargs})zb>>> Faker.seed({seed}) >>> for _ in range({size}): ... fake.{method}({kwargs}) ... {results} Samplesizeseedkwargsc@sxeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ eddZeddZdS)ProviderMethodDocstringam Class that preprocesses provider method docstrings to generate sample usage and output Notes on how samples are generated: - If the docstring belongs to a standard provider method, sample usage and output will be generated using a `Faker` object in the `DEFAULT_LOCALE`. - If the docstring belongs to a localized provider method, the correct locale will be used. - If the docstring does not belong to any provider method, docstring preprocessing will be skipped. - Docstring lines will be parsed for potential sample sections, and the generation details of each sample section will internally be represented as a ``Sample`` namedtuple. - Each ``Sample`` will have info on the keyword arguments to pass to the provider method, how many times the provider method will be called, and the initial seed value to ``Faker.seed()``. c Cst||_g|_g|_d|_t|d|d|_|dkr@dSt |}t |}t |} |r|| } | d|_ t|_nD| r| } | d|_ t|_n&|r| } | d|_ | d|_ndSd|_||dS)NTz:docstring of z : WARNING:methodlocaleF)iter _line_iter _parsed_lines_samples_skippedinspectgetfile _log_prefixrmatchr r groupdict_methodr_locale_parse_generate_samples) selfZappwhatnameobjoptionslinesZbase_provider_method_matchZlocale_provider_method_matchZstandard_provider_method_matchrr(:/tmp/pip-unpacked-wheel-cwn3b9ao/faker/sphinx/docstring.py__init__3s4        z ProviderMethodDocstring.__init__cCst|jd|dS)N )loggerwarningr)r"r-r(r(r) _log_warningSsz$ProviderMethodDocstring._log_warningcCs8zt|j}Wntk r&Yq4YqX||qdSN)nextr StopIteration_parse_section)r"liner(r(r)r Vs  zProviderMethodDocstring._parsecCs|ds|j|dSzt|j}Wn tk rH||YdSX|drj||||n&|dkr~||n||}||dS)Nz:sample) startswithrappendr0rr1_process_sample_sectionr2)r"sectionZ next_liner(r(r)r2_s       z&ProviderMethodDocstring._parse_sectionc Cst|}|s(d|d}||dS|}|d}|d}|d}|r`tt|tnt}|rpt|nt}|r| |nd}t |||}|j |dS)Nz The section `z%` is malformed and will be discarded.rrrr4) r rr.rgetmaxintDEFAULT_SAMPLE_SIZE DEFAULT_SEED_beautify_kwargsr rr6) r"r8rmsgrrrrsampler(r(r)r7}s       z/ProviderMethodDocstring._process_sample_sectioncCs4dd}dd}td||}td||}|S)NcSs |dp|d}|r|SdS)Nr4grouprquotedr(r(r)_repl_whitespaceszBProviderMethodDocstring._beautify_kwargs.._repl_whitespacecSs |dp|d}|r|SdS)NrArBz, rCrEr(r(r) _repl_commasz=ProviderMethodDocstring._beautify_kwargs.._repl_commaz("[^"]*")|(\'[^\']*\')|[ \t]+z("[^"]*")|(\'[^\']*\')|,)resubstrip)r"rrGrHresultr(r(r)r>s z(ProviderMethodDocstring._beautify_kwargscCst|Sr/)repr)r"valuer(r(r)_stringify_resultsz)ProviderMethodDocstring._stringify_resultcCsddlm}t|j|dS)Nr) OrderedDict) generatorrP) collectionsrP_faker)r"rPr(r(r)_generate_eval_scopes z,ProviderMethodDocstring._generate_eval_scopecCstttd}|j|dS)Nr4)r r<r=rr6)r"Zdefault_sampler(r(r)_inject_default_sample_sections z6ProviderMethodDocstring._inject_default_sample_sectionc sjsd}jD]}tjj|jdt}|jrfdjd|jd} |q z2t |j d fddt |jD}Wn8tk rd jd|jd} |Yq Yq X|tj|j j|j|j|d 7}q |rd |}j|ddS) Nr4)rrzNInvalid code elements detected. Sample generation will be skipped for method `z` with arguments `z`. csg|]}tqSr()rOeval).0_commandZ eval_scoper"r(r) sz=ProviderMethodDocstring._generate_samples..z%Sample generation failed for method `)rrrrresultsz :examples: )rrUrT_command_templateformatrrrerrorsr.rrjoinranger Exception_sample_output_templaterextendsplit)r"outputr@Z validatorr?r]r(rZr)r!s:   &   z)ProviderMethodDocstring._generate_samplescCs|jSr/)rr"r(r(r)skippedszProviderMethodDocstring.skippedcCs|jSr/)rrhr(r(r)r'szProviderMethodDocstring.linesN)__name__ __module__ __qualname____doc__r*r.r r2r7r>rOrTrUr!propertyrir'r(r(r(r)r$s  % r)rloggingrIrRrtypingrZfakerrZ faker.configrrZfaker.sphinx.validatorr getLoggerrjr,rScompiler__annotations__r r r r^rdr<r=r rr(r(r(r)s2