MapFileRow

QuantConnect.Data.Auxiliary.MapFileRow

MapFileRow(
    date: Union[datetime, date],
    mapped_symbol: str,
    primary_exchange: str,
    market: str = ...,
    security_type: SecurityType = ...,
    data_mapping_mode: Optional[DataMappingMode] = None,
)

MapFileRow(
    date: Union[datetime, date],
    mapped_symbol: str,
    primary_exchange: Exchange = None,
    data_mapping_mode: Optional[DataMappingMode] = None,
)

Bases: Object, IEquatable[QuantConnect_Data_Auxiliary_MapFileRow]

Represents a single row in a map_file. This is a csv file ordered as {date, mapped symbol}

Initializes a new instance of the MapFileRow class.

date

date: datetime

Gets the date associated with this data

mapped_symbol

mapped_symbol: str

Gets the mapped symbol

primary_exchange

primary_exchange: Exchange

Gets the mapped symbol

data_mapping_mode

data_mapping_mode: Optional[DataMappingMode]

Gets the securities mapping mode associated to this mapping row

__eq__

__eq__(right: MapFileRow) -> bool

Determines whether or not the two instances are equal

equals

equals(obj: Any) -> bool

equals(other: MapFileRow) -> bool

Signature descriptions:

• Determines whether the specified System.Object is equal to the current System.Object.

• Indicates whether the current object is equal to another object of the same type.

Parameters:

Name	Type	Description	Default
obj	Optional[Any]	The object to compare with the current object.	None
other	Optional[MapFileRow]	An object to compare with this object.	None

Returns:

Type	Description
bool	Depends on the signature used. Case 1: [true if the specified object is equal to the current object; otherwise, false.]; Case 2: [true if the current object is equal to the other parameter; otherwise, false.]

__ne__

__ne__(right: MapFileRow) -> bool

Determines whether or not the two instances are not equal

get_hash_code

get_hash_code() -> int

Serves as a hash function for a particular type.

Returns:

Type	Description
int	A hash code for the current System.Object.

parse

parse(
    line: str, market: str, security_type: SecurityType
) -> MapFileRow

Parses the specified line into a MapFileRow

read

read(
    file: str,
    market: str,
    security_type: SecurityType,
    data_provider: IDataProvider,
) -> Iterable[MapFileRow]

Reads in the map_file for the specified equity symbol

to_csv

to_csv() -> str

Writes this row to csv format

to_string

to_string() -> str

Convert this row into string form

Returns:

Type	Description
str	resulting string.