gme.base.gmeBase

Module: gmeBase

Classes:
  • gmeData
class gme.base.gmeBase.gmeData[source]

a class to represent a a record of gme data. Other classes will extend this class

Members:
  • time (datetime): an object identifying which time these data are for
  • dataSet (str): a string indicating the dataset
  • info (str): information about where the data come from. Please be courteous and give credit to data providers when credit is due.

Note

If any of the members have a value of None, this means that they could not be read for that specific time

Methods:
  • parseDb()
  • toDbDict()
Example:
emptyObj = gme.base.gmeData()

written by AJ, 20130131

parseDb(dbDict)[source]

This method is used to parse a dictionary of gme data from the mongodb into a gmeData object.

Note

In general, users will not need to use this.

Belongs to: gmeData

Args:
  • dbDict (dict): the dictionary from the mongodb
Returns:
  • Nothing.
Example:
myObj.parseDb(mongoDbDict)

written by AJ, 20130129

toDbDict()[source]

This method is used to convert a gmeData object into a mongodb data dictionary.

Note

In general, users will not need to worry about this

Belongs to: gmeData

Args:
  • Nothing.
Returns:
  • dbDict (dict): a dictionary in the correct format for writing to the mongodb
Example:
mongoDbDict = myObj.todbDict()

written by AJ, 20130129

gme.base.gmeBase

alias of gme.base.gmeBase

Previous topic

gme.base

Next topic

gme.base.fillGmedb

This Page