Struct genco::lang::python::Import

pub struct Import { /* fields omitted */ }

The import of a Python name from module import foo.

Created through the import() function.

Implementations

impl Import

pub fn with_alias<T>(self, alias: T) -> Self where
    T: Into<ItemStr>, 

Configure the importe name with the specified alias.

This implised that the import is not qualified.

Examples

use genco::prelude::*;

let toks = quote! {
    #(python::import("collections", "namedtuple").with_alias("nt"))
};

assert_eq!(
    vec![
        "from collections import namedtuple as nt",
        "",
        "nt",
    ],
    toks.to_file_vec()?
);

pub fn qualified(self) -> Self

Indicate that the import is qualified (module prefixed).

Examples

use genco::prelude::*;

let toks = quote! {
    #(python::import("collections", "namedtuple").qualified())
};

assert_eq!(
    vec![
        "import collections",
        "",
        "collections.namedtuple",
    ],
    toks.to_file_vec()?
);

pub fn with_module_alias<T>(self, module_alias: T) -> Self where
    T: Into<ItemStr>, 

Configure the imported name with the specified alias.

This implies that the import is qualified.

Examples

use genco::prelude::*;

let toks = quote! {
    #(python::import("collections", "namedtuple").with_module_alias("c"))
};

assert_eq!(
    vec![
        "import collections as c",
        "",
        "c.namedtuple",
    ],
    toks.to_file_vec()?
);

Trait Implementations

impl Clone for Import

fn clone(&self) -> Import

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Import

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Import

impl FormatInto<Python> for Import

fn format_into(self, tokens: &mut Tokens<Python>)

Convert the type into tokens in-place.

impl<'a> FormatInto<Python> for &'a Import

fn format_into(self, tokens: &mut Tokens<Python>)

Convert the type into tokens in-place.

impl<'a> From<&'a Import> for LangBox<Python>

fn from(value: &'a Import) -> Self

Performs the conversion.

impl From<Import> for Any

fn from(value: Import) -> Self

Performs the conversion.

impl From<Import> for LangBox<Python>

fn from(value: Import) -> Self

Performs the conversion.

impl Hash for Import

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LangItem<Python> for Import

fn format(&self, out: &mut Formatter, _: &Config, _: &Format) -> Result

Format the language item appropriately.

fn as_import(&self) -> Option<&dyn TypeTrait>

Coerce into an imported type.

fn __lang_item_as_any(&self) -> &dyn Any

LangItem convert to Any. Automatically implemented by macro.

fn __lang_item_clone(&self) -> Box<dyn LangItem<Python>>

LangItem clone. Automatically implemented by macro.

fn __lang_item_eq(&self, other: &dyn LangItem<Python>) -> bool

LangItem equality. Automatically implemented by macro.

impl Ord for Import

fn cmp(&self, other: &Import) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Import> for Import

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Import> for Import

fn partial_cmp(&self, other: &Import) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Import) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Import) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Import) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Import) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Import

impl StructuralPartialEq for Import

impl TypeTrait for Import

fn as_enum(&self) -> AnyRef

Coerce trait into an enum that can be used for type-specific operations.