gbp.git.modifier.GitModifier : API documentation

Method	__init__	No summary
Instance Variable	name	Undocumented
Instance Variable	email	Undocumented
Method	get_date	Return date as a git raw date
Method	set_date	Set date from timestamp, git raw date or datetime object
Class Variable	date	Undocumented
Method	datetime	Return the date as datetime object
Method	tz_offset	Return the date's UTC offset
Method	get_author_env	Get env vars for authorship information
Method	get_committer_env	Get env vars for committer information
Method	get	Undocumented
Method	__getitem__	Undocumented
Static Method	keys	Undocumented
Method	items	Undocumented
Method	_parse_date	Undocumented
Instance Variable	_date	Undocumented
Method	_get_env	Get author or committer information as env var dictionary

def __init__(self, name=None, email=None, date=None):

Parameters	name	the modifier's name (type: `str`)
	email	the modifier's email (type: `str`)
	date	the date of the modification (type: `str` (git raw date), `int` (timestamp) or datetime object)

name =

Undocumented

email =

Undocumented

def _parse_date(self, date):

Undocumented

_date =

Undocumented

def _get_env(self, who):

Get author or committer information as env var dictionary

def get_date(self):

Return date as a git raw date

def set_date(self, date):

Set date from timestamp, git raw date or datetime object

date =

Undocumented

@property
def datetime(self):

Return the date as datetime object

@property
def tz_offset(self):

Return the date's UTC offset

def get_author_env(self):

Get env vars for authorship information

>>> g = GitModifier("Joey Ramone", "joey@example.com")
>>> g.get_author_env()['GIT_AUTHOR_EMAIL']
'joey@example.com'
>>> g.get_author_env()['GIT_AUTHOR_NAME']
'Joey Ramone'

Returns Author information suitable to use as environment variables (type: dict)

def get_committer_env(self):

Get env vars for committer information

>>> g = GitModifier("Joey Ramone", "joey@example.com")
>>> g.get_committer_env()['GIT_COMMITTER_EMAIL']
'joey@example.com'
>>> g.get_committer_env()['GIT_COMMITTER_NAME']
'Joey Ramone'

Returns Committer information suitable to use as environment variables (type: dict)

def get(self, key, default=None):

Undocumented

def __getitem__(self, key):

Undocumented

@staticmethod
def keys():

Undocumented

def items(self):

Undocumented

gbp.git.modifier.GitModifier(object) class documentation

`gbp.git.modifier.GitModifier(object)` class documentation