sisl.geom.AtomCategory
- class sisl.geom.AtomCategory(*args, **kwargs)
Bases:
Category
Methods
categorize
(*args, **kwargs)Do categorization
is_class
(name[, case])Query whether
name
matches the class name by removing a prefixkw
kw
(**kwargs)Create categories based on keywords
Attributes
Name of category
- abstract categorize(*args, **kwargs)
Do categorization
- classmethod is_class(name, case=True) bool [source]
Query whether
name
matches the class name by removing a prefixkw
This is important to ensure that users match the full class name by omitting the prefix returned from this method.
This is an abstract method to ensure sub-classes of Category implements it.
For instance:
class MyCategory(Category): @classmethod def is_class(cls, name): # strip "My" and do comparison return cl.__name__.lower()[2:] == name.lower()
would enable one to compare against the base category scheme.
This has the option to search case-sensitivity or not.
- classmethod kw(**kwargs)
Create categories based on keywords
This will search through the inherited classes and return and & category object for all keywords.
Since this is a class method one should use this on the base category class in the given section of the code.
- property name
Name of category