Struct Parameters 

pub struct Parameters {
    pub range: TextRange,
    pub node_index: AtomicNodeIndex,
    pub posonlyargs: Vec<ParameterWithDefault>,
    pub args: Vec<ParameterWithDefault>,
    pub vararg: Option<Box<Parameter>>,
    pub kwonlyargs: Vec<ParameterWithDefault>,
    pub kwarg: Option<Box<Parameter>>,
}

An alternative type of AST arguments. This is ruff_python_parser-friendly and human-friendly definition of function arguments. This form also has advantage to implement pre-order traverse.

defaults and kw_defaults fields are removed and the default values are placed under each ParameterWithDefault typed argument. vararg and kwarg are still typed as arg because they never can have a default value.

The original Python-style AST type orders kwonlyargs fields by default existence; Parameters has location-ordered kwonlyargs fields.

NOTE: This type differs from the original Python AST. See: arguments.

Fields

range: TextRange

node_index: AtomicNodeIndex

posonlyargs: Vec<ParameterWithDefault>

args: Vec<ParameterWithDefault>

vararg: Option<Box<Parameter>>

kwonlyargs: Vec<ParameterWithDefault>

kwarg: Option<Box<Parameter>>

Implementations

impl Parameters

pub fn iter_non_variadic_params( &self, ) -> impl Iterator<Item = &ParameterWithDefault>

Returns an iterator over all non-variadic parameters included in this Parameters node.

The variadic parameters (.vararg and .kwarg) can never have default values; non-variadic parameters sometimes will.

pub fn find(&self, name: &str) -> Option<&ParameterWithDefault>

Returns the ParameterWithDefault with the given name, or None if no such ParameterWithDefault exists.

pub fn index(&self, name: &str) -> Option<usize>

Returns the index of the parameter with the given name

pub fn iter(&self) -> ParametersIterator<'_>

Returns an iterator over all parameters included in this Parameters node.

pub fn len(&self) -> usize

Returns the total number of parameters included in this Parameters node.

pub fn includes(&self, name: &str) -> bool

Returns true if a parameter with the given name is included in this Parameters.

pub fn is_empty(&self) -> bool

Returns true if the Parameters is empty.

pub fn iter_source_order(&self) -> ParametersSourceOrderIterator<'_>

Returns an iterator over all parameters in source order.

This differs from Parameters::iter which returns parameters in type-based order (positional-only, regular, variadic, keyword-only, keyword). For well-formed Python the two orderings are identical, but error recovery can produce ASTs where variadic parameters appear before non-variadic ones (e.g. def foo(**kwargs, a):).

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Parameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Parameters

Returns the “default value” for a type.

impl<'a> From<&'a Parameters> for AnyNodeRef<'a>

fn from(node: &'a Parameters) -> AnyNodeRef<'a>

Converts to this type from the input type.

impl<'a> From<&'a Parameters> for AnyRootNodeRef<'a>

fn from(node: &'a Parameters) -> AnyRootNodeRef<'a>

Converts to this type from the input type.

impl<'a> From<&'a Parameters> for ComparableParameters<'a>

fn from(parameters: &'a Parameters) -> ComparableParameters<'a>

Converts to this type from the input type.

impl GetSize for Parameters

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

where TRACKER: GetSizeTracker,

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl HasNodeIndex for Parameters

fn node_index(&self) -> &AtomicNodeIndex

Returns the AtomicNodeIndex for this node.

impl<'a> IntoIterator for &'a Box<Parameters>

type IntoIter = ParametersIterator<'a>

Which kind of iterator are we turning this into?

type Item = AnyParameterRef<'a>

The type of the elements being iterated over.

fn into_iter(self) -> <&'a Box<Parameters> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Parameters

type IntoIter = ParametersIterator<'a>

Which kind of iterator are we turning this into?

type Item = AnyParameterRef<'a>

The type of the elements being iterated over.

fn into_iter(self) -> <&'a Parameters as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Parameters

fn eq(&self, other: &Parameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Ranged for Parameters

fn range(&self) -> TextRange

The range of this item in the source text.

fn start(&self) -> TextSize

The start offset of this item in the source text.

fn end(&self) -> TextSize

The end offset of this item in the source text.

impl<'a> TryFrom<AnyRootNodeRef<'a>> for &'a Parameters

type Error = ()

The type returned in the event of a conversion error.

fn try_from(node: AnyRootNodeRef<'a>) -> Result<&'a Parameters, ()>

Performs the conversion.

impl StructuralPartialEq for Parameters