Stash Software API  2.0.0
Classes | Public Member Functions | Static Public Member Functions | List of all members
sDeveloper.developerLib.Developer Class Reference

[ CLASS ] - Class to operate on developers. More...

Inheritance diagram for sDeveloper.developerLib.Developer:

Classes

class  AttributeName
 [ ENUM CLASS ] - Attribute names class. More...
 

Public Member Functions

def __init__ (self, developer=getuser())
 Constructor. More...
 
def __str__ (self)
 String representation. More...
 
def setDeveloper (self, developer)
 Set developer. More...
 
Properties
def userName (self)
 Property. More...
 
def name (self)
 Property. More...
 
def position (self)
 Property. More...
 
def email (self)
 Property. More...
 
def site (self)
 Property. More...
 
def url (self)
 Property. More...
 

Static Public Member Functions

def getDeveloperModule (developerLib)
 Get developer module for given user. More...
 
def listDevelopersAsStr ()
 List developer user names. More...
 
def isDeveloper (user=getuser())
 Check whether given user is valid developer with a developer module. More...
 
def listDeveloperModules ()
 List developer modules. More...
 

Detailed Description

[ CLASS ] - Class to operate on developers.

Constructor & Destructor Documentation

◆ __init__()

def sDeveloper.developerLib.Developer.__init__ (   self,
  developer = getuser() 
)

Constructor.

Developer module instance could be passed as user argument as well as user name of the developer as a string.

Developer module can be obtained from sDeveloper.developerLib.Developer.getDeveloperModule method.

Parameters
developer[ str, module | getpass.getuser | in ] - User name or the module of the developer.
Exceptions
N/A
Returns
None - None.

Member Function Documentation

◆ __str__()

def sDeveloper.developerLib.Developer.__str__ (   self)

String representation.

Exceptions
N/A
Returns
str - String representation.

◆ userName()

def sDeveloper.developerLib.Developer.userName (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ name()

def sDeveloper.developerLib.Developer.name (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ position()

def sDeveloper.developerLib.Developer.position (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ email()

def sDeveloper.developerLib.Developer.email (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ site()

def sDeveloper.developerLib.Developer.site (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ url()

def sDeveloper.developerLib.Developer.url (   self)

Property.

Exceptions
N/A
Returns
variant - Value.

◆ setDeveloper()

def sDeveloper.developerLib.Developer.setDeveloper (   self,
  developer 
)

Set developer.

Developer module instance can be provided for developer argument as well as user name of the developer as a string.

Parameters
developer[ str, module | None | in ] - Developer user name or the module of the developer.
Exceptions
ValueError- If given developer doesn't exist.
NameError- If developer module doesn't have all the attributes.
ValueError- If an attribute ID empty and this attribute is not person website URL.
AttributeError- If INFO dictionary doesn't match with attributes in developer module.
Returns
bool - Result.

◆ getDeveloperModule()

def sDeveloper.developerLib.Developer.getDeveloperModule (   developerLib)
static

Get developer module for given user.

Parameters
developerLib[ str | None | in ] - Developer module name.
Returns
module - Developer module.

◆ listDevelopersAsStr()

def sDeveloper.developerLib.Developer.listDevelopersAsStr ( )
static

List developer user names.

Method returns the user name of the developers with Lib postfix which represents the python modules for the developers.

Exceptions
N/A
Returns
list of str - User name of the developers.

◆ isDeveloper()

def sDeveloper.developerLib.Developer.isDeveloper (   user = getuser())
static

Check whether given user is valid developer with a developer module.

Parameters
user[ str, module | getpass.getuser | in ] - User name of the user.
Exceptions
N/A
Returns
None - If user is not a valid developer.
str - Developer module name if user is a developer.

◆ listDeveloperModules()

def sDeveloper.developerLib.Developer.listDeveloperModules ( )
static

List developer modules.

Exceptions
N/A
Returns
list of module - Developer modules.

The documentation for this class was generated from the following file: