def funds_as_df(country=None):
"""
This function retrieves all the available `funds` from Investing.com and returns them as a :obj:`pandas.DataFrame`,
which contains not just the fund names, but all the fields contained on the funds file.
All the available funds can be found at: https://es.investing.com/funds/
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available funds from.
Returns:
:obj:`pandas.DataFrame` - funds_df:
The resulting :obj:`pandas.DataFrame` contains all the funds basic information retrieved from Investing.com,
some of which is not useful for the user, but for the inner package functions, such as the `id` field,
for example.
In case the information was successfully retrieved, the :obj:`pandas.DataFrame` will look like::
asset class | id | isin | issuer | name | symbol | tag | currrency
------------|----|------|--------|------|--------|-----|-----------
xxxxxxxxxxx | xx | xxxx | xxxxxx | xxxx | xxxxxx | xxx | xxxxxxxxx
Just like `investpy.funds.retrieve_funds()` :obj:`pandas.DataFrame` output, but instead of generating the
CSV file, this function just reads it and loads it into a :obj:`pandas.DataFrame` object.
Raises:
IOError: if the funds file from `investpy` is missing or errored.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'funds', 'funds.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
funds = pd.read_csv(
pkg_resources.resource_filename(resource_package, resource_path))
else:
funds = retrieve_funds(test_mode=False)
if funds is None:
raise IOError("ERR#0005: funds not found or unable to retrieve.")
if country is None:
funds.reset_index(drop=True, inplace=True)
return funds
elif unidecode.unidecode(country.lower()) in fund_countries_as_list():
funds = funds[funds['country'] == unidecode.unidecode(country.lower())]
funds.reset_index(drop=True, inplace=True)
return funds
def funds_as_list(country=None):
"""
This function retrieves all the available funds and returns a list of each one of them.
All the available funds can be found at: https://es.investing.com/funds/
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available funds from.
Returns:
:obj:`list` - funds_list:
The resulting list contains the retrieved data, which corresponds to the fund names of
every fund listed on Investing.com.
In case the information was successfully retrieved from the CSV file, the :obj:`list` will look like::
funds = ['Blackrock Global Funds - Global Allocation Fund E2',
'Quality Inversión Conservadora Fi',
'Nordea 1 - Stable Return Fund E Eur',
...]
Raises:
ValueError: raised when the introduced arguments are not correct.
IOError: if the funds file from `investpy` is missing or errored.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'funds', 'funds.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
funds = pd.read_csv(
pkg_resources.resource_filename(resource_package, resource_path))
else:
funds = retrieve_funds(test_mode=False)
if funds is None:
raise IOError("ERR#0005: funds not found or unable to retrieve.")
if country is None:
return funds['name'].tolist()
elif unidecode.unidecode(country.lower()) in fund_countries_as_list():
return funds[funds['country'] == unidecode.unidecode(
country.lower())]['name'].tolist()
def test_funds_errors():
"""
This function raises errors on fund retrieval functions
"""
try:
retrieve_funds(test_mode=None)
except:
pass
try:
retrieve_fund_countries(test_mode=None)
except:
pass
params = [
{
'country': ['error'],
},
]
for param in params:
try:
investpy.get_funds(country=param['country'])
except:
pass
try:
investpy.get_funds_list(country=param['country'])
except:
pass
params = [
{
'country': ['error'],
'columns': None,
'as_json': False
},
{
'country': None,
'columns': None,
'as_json': 'error'
},
{
'country': None,
'columns': 0,
'as_json': True
},
{
'country': None,
'columns': ['error'],
'as_json': False
},
]
for param in params:
try:
investpy.get_funds_dict(country=param['country'],
columns=param['columns'],
as_json=param['as_json'])
except:
pass
params = [
{
'fund': None,
'country': 'spain',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': None,
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': ['error'],
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'error',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'germany',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'as_json': 'error',
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'as_json': True,
'order': 'error',
'debug': True
},
{
'fund': 'error',
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': True
},
{
'fund': ['error'],
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': 'error'
},
]
for param in params:
try:
investpy.get_fund_recent_data(fund=param['fund'],
country=param['country'],
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
except:
pass
params = [
{
'fund': None,
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': None,
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': ['error'],
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'error',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'germany',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': 'error',
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': 'error',
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'error',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': 'error',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': 'error',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'error',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': ['error'],
'country': 'spain',
'from_date': '01/01/1998',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/1998',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': '01/01/1998',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/1900',
'to_date': '01/01/1950',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': '01/03/2019',
'as_json': False,
'order': 'ascending',
'debug': 'error'
},
]
for param in params:
try:
investpy.get_fund_historical_data(fund=param['fund'],
country=param['country'],
from_date=param['from_date'],
to_date=param['to_date'],
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
except:
pass
params = [
{
'fund': None,
'country': 'spain',
'as_json': False
},
{
'fund': 'quality inversion conservadora fi',
'country': None,
'as_json': False
},
{
'fund': 'quality inversion conservadora fi',
'country': ['error'],
'as_json': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'error',
'as_json': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'germany',
'as_json': False
},
{
'fund': 'quality inversion conservadora fi',
'country': 'spain',
'as_json': 'error'
},
{
'fund': 'error',
'country': 'spain',
'as_json': True
},
{
'fund': ['error'],
'country': 'spain',
'as_json': True
},
]
for param in params:
try:
investpy.get_fund_information(fund=param['fund'],
country=param['country'],
as_json=param['as_json'])
except:
pass
params = [
{
'by': None,
'value': 'bbva',
},
{
'by': ['error'],
'value': 'bbva',
},
{
'by': 'error',
'value': 'bbva',
},
{
'by': 'name',
'value': None,
},
{
'by': 'name',
'value': ['error'],
},
{
'by': 'isin',
'value': 'error',
},
]
for param in params:
try:
investpy.search_funds(by=param['by'], value=param['value'])
except:
pass
def test_investpy_funds():
"""
This function checks that fund data retrieval functions listed in investpy work properly.
"""
params = [
{
'country': 'spain',
},
{
'country': None,
},
]
for param in params:
investpy.get_funds(country=param['country'])
investpy.get_funds_list(country=param['country'])
params = [
{
'country': None,
'columns': ['id', 'name'],
'as_json': True
},
{
'country': None,
'columns': ['id', 'name'],
'as_json': False
},
{
'country': 'spain',
'columns': ['id', 'name'],
'as_json': True
},
{
'country': 'spain',
'columns': ['id', 'name'],
'as_json': False
},
{
'country': 'spain',
'columns': None,
'as_json': False
},
]
for param in params:
investpy.get_funds_dict(country=param['country'],
columns=param['columns'],
as_json=param['as_json'])
investpy.get_fund_countries()
params = [
{
'as_json': True,
'order': 'ascending',
'debug': False
},
{
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'as_json': True,
'order': 'descending',
'debug': False
},
{
'as_json': False,
'order': 'descending',
'debug': False
},
]
for param in params:
investpy.get_fund_recent_data(fund='bbva multiactivo conservador pp',
country='spain',
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
investpy.get_fund_historical_data(
fund='bbva multiactivo conservador pp',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019',
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
params = [
{
'fund': 'bbva multiactivo conservador pp',
'country': 'spain',
'as_json': True,
},
{
'fund': 'bbva multiactivo conservador pp',
'country': 'spain',
'as_json': False,
},
]
for param in params:
investpy.get_fund_information(fund=param['fund'],
country=param['country'],
as_json=param['as_json'])
investpy.search_funds(by='name', value='bbva')
retrieve_funds(test_mode=True)
retrieve_fund_countries(test_mode=True)
def funds_as_dict(country=None, columns=None, as_json=False):
"""
This function retrieves all the available funds on Investing.com and returns them as a :obj:`dict` containing the
`asset_class`, `id`, `issuer`, `name`, `symbol`, `tag` and `currency`. All the available funds can be found at:
https://es.investing.com/funds/
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available funds from.
columns (:obj:`list` of :obj:`str`, optional): description
a :obj:`list` containing the column names from which the data is going to be retrieved.
as_json (:obj:`bool`, optional): description
value to determine the format of the output data (:obj:`dict` or :obj:`json`).
Returns:
:obj:`dict` or :obj:`json` - funds_dict:
The resulting :obj:`dict` contains the retrieved data if found, if not, the corresponding
fields are filled with `None` values.
In case the information was successfully retrieved, the :obj:`dict` will look like::
{
'asset class': asset_class,
'id': id,
'isin': isin,
'issuer': issuer,
'name': name,
'symbol': symbol,
'tag': tag,
'currency': currency
}
Raises:
ValueError: raised when the introduced arguments are not correct.
IOError: raised if the funds file from `investpy` is missing or errored.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
if not isinstance(as_json, bool):
raise ValueError(
"ERR#0002: as_json argument can just be True or False, bool type.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'funds', 'funds.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
funds = pd.read_csv(
pkg_resources.resource_filename(resource_package, resource_path))
else:
funds = retrieve_funds(test_mode=False)
if funds is None:
raise IOError("ERR#0005: funds not found or unable to retrieve.")
if columns is None:
columns = funds.columns.tolist()
else:
if not isinstance(columns, list):
raise ValueError(
"ERR#0020: specified columns argument is not a list, it can just be list type."
)
if not all(column in funds.columns.tolist() for column in columns):
raise ValueError(
"ERR#0023: specified columns does not exist, available columns are "
"<country, asset class, id, isin, issuer, name, symbol, tag, currency>"
)
if country is None:
if as_json:
return json.dumps(funds[columns].to_dict(orient='records'))
else:
return funds[columns].to_dict(orient='records')
elif country in fund_countries_as_list():
if as_json:
return json.dumps(funds[funds['country'] == unidecode.unidecode(
country.lower())][columns].to_dict(orient='records'))
else:
return funds[funds['country'] == unidecode.unidecode(
country.lower())][columns].to_dict(orient='records')