o hFh@sddlZddlZddlmZddlmZddlmZddlmZddlm Z ddlm Z ddlm Z dd lm Z dd lm Z dd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlZddlmZddlmZddlmZddlmZddlmZddlmZddl m!Z!ddl m"Z"ddl#m$Z$ddl#m%Z%ddl&m'Z'ddl&m(Z(ddl&m)Z)dd l*m+Z+dd!l,m-Z-dd"l,m.Z.dd#l/m0Z0dd$l1m2Z2erdd%l3m4Z4dd&lm5Z5d'Z6eej7j8Z9d(e:d)e e:fd*d+Z;d,ed-ed)dfd.d/ZGd6d7d7e?Z@Gd8d1d1e@d9ZAd:d1d)eee:efeeBffd;d<ZCGd=d>d>eAZDd?d@d,ed)ee:fdAdBZEGdCdDdDeDZFGdEdFdFeFZGGdGdHdHeAZHdS)IN) signature)Path)Any)Callable)cast)Iterable)Iterator)List)MutableMapping)Optional)overload)Set)Tuple)Type) TYPE_CHECKING)TypeVar)Union) getfslineno) ExceptionInfo) TerminalRepr) Traceback)cached_property) LEGACY_PATH)Config)ConftestImportFailure)#FSCOLLECTOR_GETHOOKPROXY_ISINITPATH)NODE_CTOR_FSPATH_ARG)Mark) MarkDecorator) NodeKeywords)fail) absolutepath) commonpath)Stash) PytestWarning)Session)_TracebackStyle/nodeidreturnccsd}|d}|dkrd}dV |t||}|dkrn|dkr)|d|V|tt}q |d|}|dkrs z$NodeMeta._create..)PytestDeprecationWarningz7 is not using a cooperative constructor and only takes z. See https://docs.pytest.org/en/stable/deprecations.html#constructors-of-custom-pytest-node-subclasses-should-take-kwargs for more details.) superrQ TypeErrorrgetattritems warning_typesrZr@rAset)rMrNrOknown_kwrZ __class__rVr4_creates   zNodeMeta._create)rCrL __qualname__rQrd __classcell__r3r3rbr4rGs rGc@sReZdZUdZeed<dZ      dDdedddee d d deed ee d eed dfddZ e dEddZ eddZd efddZded dfddZed efddZd efddZdFddZdFdd Zd edfd!d"Z #dGd$eeefd%ed dfd&d'ZdHdeed eefd(d)Z dHdeed ee!deffd*d+Z"e#ded eefd,d-Z$e#ded.ed efd/d-Z$ dHded.eed eefd0d-Z$d e%efd1d2Z&d eefd3d4Z'd5e(ge)fd dfd6d7Z*d8e+e,d ee,fd9d:Z-d;e.e/d e0fdd?d e2fd@dAZ3 dHd;e.e/d>d?d eee2ffdBdCZ4dS)Ir;zBase class of :class:`Collector` and :class:`Item`, the components of the test collection tree. ``Collector``\'s are the internal nodes of the tree, and ``Item``\'s are the leaf nodes. r7)rJparentconfigsessionr6_nodeid_store__dict__NrJrgzOptional[Node]rhrizOptional[Session]r6r(r)cCs||_||_|r ||_n |std|j|_|r||_n |s"td|j|_|dur4|dur4t|dd}tt|||d|_t ||_ g|_ t |_ |durXd|vsTJ||_n|js_td|jjd|j|_t|_|j|_dS)Nz!config or parent must be providedz"session or parent must be providedr6r7z::()z!nodeid or parent must be providedr*)rJrgrhr\rir]rDtyper6rkeywords own_markersr`extra_keyword_matchesrjr(r#stashrk)rMrJrgrhrir7r6r(r3r3r4rRs4     z Node.__init__cKs4d|vrtdd|vrtd|jdd|i|S)a:Public constructor for Nodes. This indirection got introduced in order to enable removing the fragile logic from the node constructors. Subclasses can use ``super().from_parent(...)`` when overriding the construction. :param parent: The parent node of this Node. rhz.config is not a valid argument for from_parentriz/session is not a valid argument for from_parentrgNr3)r\rd)clsrgrOr3r3r4 from_parents  zNode.from_parentcCs|j|jS)z6fspath-sensitive hook proxy used to call pytest hooks.)ri gethookproxyr6rMr3r3r4ihook sz Node.ihookcCsd|jjt|ddS)Nz<{} {}>rJ)rBrcrCr]rvr3r3r4__repr__sz Node.__repr__warningcCsNt|ts td|t|\}}|dusJtj|dt||dddS)awIssue a warning for this Node. Warnings will be displayed after the test session, unless explicitly suppressed. :param Warning warning: The warning instance to issue. :raises ValueError: If ``warning`` instance is not a subclass of Warning. Example usage: .. code-block:: python node.warn(PytestWarning("some message")) node.warn(UserWarning("some message")) .. versionchanged:: 6.2 Any subclass of :class:`Warning` is now accepted, rather than only :class:`PytestWarning ` subclasses. zs z Node.__hash__cCdSrr3rvr3r3r4setupAz Node.setupcCrrr3rvr3r3r4teardownDrz Node.teardowncCs4g}|}|dur|||j}|dus||S)zReturn list of all parent collectors up to self, starting from the root of collection tree. :returns: The nodes. N)appendrgreverse)rMchainitemr3r3r4 listchainGs zNode.listchainTmarkerrcCspddlm}t|tr|}nt|trt||}ntd||j|j<|r.|j |j dS|j d|j dS)zDynamically add a marker object to the node. :param marker: The marker. :param append: Whether to append the marker, or prepend it. r)MARK_GENz'is not a string or pytest.mark.* MarkerN) _pytest.markrr}rrr]r8rorJrprmarkinsert)rMrrrmarker_r3r3r4 add_markerUs    zNode.add_markercCsdd|j|dDS)zIterate over all markers of the node. :param name: If given, filter the results by the name attribute. :returns: An iterator of the markers of the node. css|]}|dVqdS)rYNr3rTxr3r3r4 ssz$Node.iter_markers..rI)iter_markers_with_noderMrJr3r3r4 iter_markersmszNode.iter_markersccsFt|D]}|jD]}|dust|dd|kr||fVq qdS)zIterate over all markers of the node. :param name: If given, filter the results by the name attribute. :returns: An iterator of (node, mark) tuples. NrJ)reversedrrpr])rMrJnoderr3r3r4rus  zNode.iter_markers_with_nodecCrrr3rr3r3r4get_closest_markerzNode.get_closest_markerdefaultcCrrr3rMrJrr3r3r4rrcCst|j|d|S)zReturn the first marker matching the name, from closest (for example function) to farther level (for example module level). :param default: Fallback return value if no marker was found. :param name: Name to filter by. rI)nextrrr3r3r4rs cCs$t}|D]}||jq|S)z;Return a set of all extra keywords in self and any parents.)r`rupdaterq)rMextra_keywordsrr3r3r4listextrakeywordss zNode.listextrakeywordscCsdd|DS)NcSsg|]}|jqSr3rIrr3r3r4 sz"Node.listnames..)rrvr3r3r4 listnamesszNode.listnamesfincCs|jj||dS)zRegister a function to be called without arguments when this node is finalized. This method can only be called when this node is active in a setup chain, for example during self.setup(). N)ri _setupstate addfinalizer)rMrr3r3r4rszNode.addfinalizerrscCs@|}|rt||s|j}|rt||r |dust||sJ|S)zGet the next parent node (including self) which is an instance of the given class. :param cls: The node class to search for. :returns: The node, if found. N)r}rg)rMrscurrentr3r3r4 getparents zNode.getparentexcinfocCs|jSr) traceback)rMrr3r3r4_traceback_filterszNode._traceback_filterstylezOptional[_TracebackStyle]cCsddlm}t|jtrt|jj}t|jtj r |jj s d}t|j|r+|j S|j ddr7d}d}n |j}|dkr@d}|durR|j ddd krPd }nd}|j d dd kr^d}nd }z tt|j jjk}Wn tyxd }Ynw|jd ||j d d|||dS)Nr)FixtureLookupErrorvalue fulltraceFlongautotbstyleshortverboserYT showlocals)funcargsabspathrrtbfiltertruncate_locals)_pytest.fixturesrr}rrr from_exc_inforr ExceptionrK formatreprrh getoptionrrosgetcwdinvocation_paramsdirOSErrorgetrepr)rMrrrrrrr3r3r4_repr_failure_pysD      zNode._repr_failure_pycCs |||S)zReturn a representation of a collection or test failure. .. seealso:: :ref:`non-python tests` :param excinfo: Exception information for the failure. )r)rMrrr3r3r4 repr_failure zNode.repr_failure)NNNNNN)rgr;r)N)Tr)5rCrLre__doc__r__annotations__ __slots__rr rrrR classmethodrtpropertyrwrxr~rAr(intrrrr rrrboolrrrrrrr rr rrrobjectrrrErr BaseExceptionrrrrrr3r3r3r4r;s   =  '            : ) metaclassrcCsLt|dd}|dur|ddSt|dd}|durt|St|dddfS)aTry to extract the actual location from a node, depending on available attributes: * "location": a pair (path, lineno) * "obj": a Python object that the node wraps. * "fspath": just a path :rtype: A tuple of (str|Path, int) with filename and 0-based line number. locationNobjr7zunknown locationr+)r]r)rrrr3r3r4rs   rc@sjeZdZdZGdddeZdeedfddZde e dee e ffd d Z de e defd d Zd S) CollectorzBase class of all collectors. Collector create children through `collect()` and thus iteratively build the collection tree. c@eZdZdZdS)zCollector.CollectErrorz6An error during collection, contains a custom message.NrCrLrerr3r3r3r4 CollectErrorrr))ItemrcCtd)z;Collect children (items and collectors) for this collector.abstractNotImplementedErrorrvr3r3r4collectszCollector.collectrcCsXt|j|jr|jdds|j}t|jdS|jdd}|dkr%d}|j||dS)zyReturn a representation of a collection failure. :param excinfo: Exception information for the failure. rFrrrr)r)r}rrrhrrargsr)rMrexcrr3r3r4rszCollector.repr_failurecCsDt|dr|j}|j|jd}||kr|jtd}|j|S|jS)Nr6r6) excludepath)hasattrrcutr6tracebackcutdirfilter)rMrr ntracebackr3r3r4r4s   zCollector._traceback_filterN)rCrLrerrrrrrrrrrrrrr3r3r3r4rs  rrir%cCsD|jD]}t|||krt||}|dkrdS|SqdS)NrHr,) _initialpathsr"r relative_to)rir6 initial_pathrelr3r3r4_check_initialpaths_for_relpath>s rcseZdZdZ        ddeedeeeefdeedee deedee d ed d ee d dffd d Z e ddddeedeeffddZ dddZdee dfd efddZZS) FSCollectorz%Base class for filesystem collectors.Nr7path_or_parentr6rJrgrhrir%r(r)c sB|r t|tr|dus Jtt|}n t|tr |dusJ|}tt|||d}|durV|j}|durV|j|krVz| |j} Wn t yJYnwt | }| t jt}||_|durf|duscJ|j}|durz t |j |jj}Wnt yt||}Ynw|rt jtkr| t jt}tj||||||ddS)Nrm)rJrgrhrir(r6)r}r;rrrrDrnrJr6rr8rreplacersepr.rirhrootpathrr[rR) rMr7rr6rJrgrhrir(rrbr3r4rRIsL         zFSCollector.__init__)r7r6c stjd|||d|S)zThe public constructor.)rgr7r6Nr3)r[rt)rsrgr7r6rOrbr3r4rts zFSCollector.from_parentos.PathLike[str]cCtjtdd|j|SNrr>)r@rArriru)rMr7r3r3r4ru zFSCollector.gethookproxycCrr)r@rArri isinitpath)rMr6r3r3r4rrzFSCollector.isinitpath)NNNNNNNN)r7r)rCrLrerr rrrr;rrrRrrtrurrrfr3r3rbr4rFsN  6 "rc@r)FilezOBase class for collecting tests from a file. :ref:`non-python tests`. Nrr3r3r3r4rrrc seZdZdZdZ    ddeededdeeddffdd Zdd d Z dd d Z dedededdfddZ de e defeeeffddZede eeeeffddZZS)rzBase class of all test invocation items. Note that for a single function there might be multiple test invocation items. Nrhrir%r(r)c s6tj||f|||d|g|_g|_|dS)N)rhrir()r[rR_report_sectionsuser_properties-_check_item_and_collector_diamond_inheritance)rMrJrgrhrir(rOrbr3r4rRs  z Item.__init__cCsdt|}d}t||drdSt||dddd|jD}|r0t|jd|d tdSdS) z Check if the current type inherits from both File and Collector at the same time, emitting a warning accordingly (#8447). )_pytest_diamond_inheritance_warning_shownFNTz, css |] }t|tr|jVqdSr) issubclassrrC)rTbaser3r3r4rs   zEItem._check_item_and_collector_diamond_inheritance..zF is an Item subclass and should not be a collector, however its bases z are collectors. Please split the Collectors and the Item into separate node types. Pytest Doc example: https://docs.pytest.org/en/latest/example/nonpython.html example pull request on a plugin: https://github.com/asmeurer/pytest-flakes/pull/40/) rnr]setattrjoin __bases__r@rArCr$)rMrs attr_nameproblemsr3r3r4rs    z2Item._check_item_and_collector_diamond_inheritancecCr)zRun the test case for this item. Must be implemented by subclasses. .. seealso:: :ref:`non-python tests` z,runtest must be implemented by Item subclassrrvr3r3r4runtestsz Item.runtestwhenkeycontentcCs|r |j|||fdSdS)aAdd a new report section, similar to what's done internally to add stdout and stderr captured output:: item.add_report_section("call", "stdout", "report section contents") :param str when: One of the possible capture states, ``"setup"``, ``"call"``, ``"teardown"``. :param str key: Name of the section, can be customized at will. Pytest uses ``"stdout"`` and ``"stderr"`` internally. :param str content: The full contents as a string. N)rr)rMr r r r3r3r4add_report_sectionszItem.add_report_sectionrcCs |jddfS)aPGet location information for this item for test reports. Returns a tuple with three elements: - The path of the test (default ``self.path``) - The 0-based line number of the test (default ``None``) - A name of the test to be shown (default ``""``) .. seealso:: :ref:`non-python tests` Nr,rrvr3r3r4 reportinforzItem.reportinfocCsL|}tt|d}|j|}t|dtusJ||d|dfS)z Returns a tuple of ``(relfspath, lineno, testname)`` for this item where ``relfspath`` is file path relative to ``config.rootpath`` and lineno is a 0-based line number. rrrY)r r!rr7ri_node_location_to_relpathrnr)rMrr6 relfspathr3r3r4rs  z Item.location)NNNNr)rCrLrernextitemr rrrRrrr rrrr rrrfr3r3rbr4rs,   $ &r)Irr@inspectrpathlibrtypingrrrrrr r r r r rrrrr _pytest._code_pytestr_pytest._code.coderrr_pytest.compatrr_pytest.configrr_pytest.deprecatedrr_pytest.mark.structuresrrr_pytest.outcomesr _pytest.pathlibr!r" _pytest.stashr#_pytest.warning_typesr$ _pytest.mainr%r&r.__file__rgrrr5r9rDrErnrGr;rrrrrrrr3r3r3r4s                                      - &`.N