2~hO!UddlZddlZddlZddlmZddlmZddlmZddl m Z m Z ddl m Z ejeZee Zej$dZeed<ej$d Zeed <ej$d Zeed <ej$d Zeed<dZdZdZdZedgdZGddZy)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} Sample)sizeseedkwargscleZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z ed Zed Zy)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()``. cVt||_g|_g|_d|_t j |d|d|_|dk7rytj|}tj|}tj|} |r&|j} | d|_ t|_nP| r&| j} | d|_ t|_n(|r%|j} | d|_ | d|_nyd|_|j!|j#y)NTz:docstring of z : WARNING:methodlocaleF)iter _line_iter _parsed_lines_samples_skippedinspectgetfile _log_prefixr matchr r groupdict_methodr_locale_parse_generate_samples) selfappwhatnameobjoptionslinesbase_provider_method_matchlocale_provider_method_matchstandard_provider_method_matchr s _/var/www/peopleoo.sandbox-dev.co.uk/venv/lib/python3.12/site-packages/faker/sphinx/docstring.py__init__z ProviderMethodDocstring.__init__3su+  %ooc23>$zR 8  %B%H%H%N"'F'L'LT'R$)J)P)PQU)V& %2<<>I$X.DL)DL +6@@BI$X.DL)DL )4>>@I$X.DL$X.DL     cLtj|jd|y)N )loggerwarningr)r%r5s r/ _log_warningz$ProviderMethodDocstring._log_warningSs $**+1WI67r1cr t|j}|j|(#t$rYywxYwN)nextr_parse_section StopIteration)r%lines r/r#zProviderMethodDocstring._parseVsA *DOO,##D) !  s * 66c|jds|jj|y t|j}|jdr#|j ||j|y|dk(r|j |y||z}|j|y#t $r|j |YywxYw)Nz:sample) startswithrappendr9rr;_process_sample_sectionr:)r%section next_lines r/r:z&ProviderMethodDocstring._parse_section_s!!),    % %g .  T__-I    *  ( ( 1    *"_  ( ( 1  )G    ()   ( ( 1  sB&&CCctj|}|sd|d}|j|y|j}|j d}|j d}|j d}|rt t |tnt}|r t |nt}|r|j|nd}t|||}|jj|y)Nz The section `z%` is malformed and will be discarded.rrrr>) r rr6r getmaxintDEFAULT_SAMPLE_SIZE DEFAULT_SEED_beautify_kwargsrrr@) r%rBrmsgr rrrsamples r/rAz/ProviderMethodDocstring._process_sample_section}s$**73!'*OPC   c " OO% }}V$}}V$x(6:s3t912@S s4yl28&&v.bdF+ V$r1cd}d}tjd||}tjd||}|jS)NcV|jdxs|jd}|r|SdS)Nr>grouprquoteds r/_repl_whitespacezBProviderMethodDocstring._beautify_kwargs.._repl_whitespaces)[[^5u{{1~F#6 + +r1cV|jdxs|jd}|r|SdS)NrOrPz, rQrSs r/ _repl_commaz=ProviderMethodDocstring._beautify_kwargs.._repl_commas)[[^5u{{1~F#6 - -r1z("[^"]*")|(\'[^\']*\')|[ \t]+z("[^"]*")|(\'[^\']*\')|,)resubstrip)r%rrUrWresults r/rJz(ProviderMethodDocstring._beautify_kwargssE , . 8:JFS3[&I||~r1ct|Sr8)repr)r%values r/_stringify_resultz)ProviderMethodDocstring._stringify_results E{r1c:ddlm}t|j|dS)Nr) OrderedDict) generatorra) collectionsra_faker")r%ras r/_generate_eval_scopez,ProviderMethodDocstring._generate_eval_scopes +t||,&  r1cdtttd}|jj |y)Nr>)rrHrIrr@)r%default_samples r/_inject_default_sample_sectionz6ProviderMethodDocstring._inject_default_sample_sections# 3\2F ^,r1c |js|jd}|j}|jD]$}tj |j |j }t|}|jr/d|j d|j d}|j|u tj|jdjt|jDcgc]}|jt!||c}}|t"j |j|j |j |j|z }'|r0d |z}|j&j)|j+dyycc}w#t$$r2d|j d|j d}|j|YwxYw) Nr>)rrzNInvalid code elements detected. Sample generation will be skipped for method `z` with arguments `z`. )rrrrresultsz%Sample generation failed for method `z :examples: )rrhre_command_templateformatr!rrerrorsr6rrjoinrangerr_eval_sample_output_template Exceptionrextendsplit) r%output eval_scoperLcommand validatorrK_rks r/r$z)ProviderMethodDocstring._generate_sampless}}  / / 1..0 mm F'..dll6==.YG+G4I++/<<.8J6==/Y[]!!#&  6;;'))`eflfqfq`r$s[\T%;%;D*rs ":6   8 $  )34h)iwi-7RZZ8m-n!7n+52::f,!+ q!g3 H8 9{"{"r1