Quantopian's community platform is shutting down. Please read this post for more information and download your code.
Back to Community
Is there a way to list all the attributes of the function "quantopian.research.prices"? On using the 'getattr' function, I see a warning about whitelisted modules.

I was going through lesson 1 of the tutorials and saw the example using the rolling() attribute of the function prices from quantopian.research module. I tried to see what other attributed this function has, so I used the getattr method on 'prices' and this is the message I see

InputRejected:  
Insecure built-in function 'getattr' You tried to import a module that is not whitelisted on Quantopian. To see the list of allowed modules in the IDE, go to https://www.quantopian.com/docs/whitelists/ide-whitelist#algo-ide-whitelist. To see the list of additional modules allowed in Research, go to https://www.quantopian.com/docs/whitelists/research-whitelist#research-whitelist.  

And I did go the both those sites and searched for 'prices' or 'rolling' and I couldn't find what I was looking for. Why am I being stopped from looking at the list of methods inside 'prices' if I am going to be using them anyway? Or am I getting something wrong here?

2 responses

The best way to get info on methods and functions is to use help. So something like this

# This typically gives the best results  
help(prices)

# This will display the actual docstring but may be more obtuse at times  
prices?

The key is to look at the output object. In this case

    Data is returned as a :class:`pd.Series` if a single asset is passed.  
    Data is returned as a :class:`pd.DataFrame` if multiple assets are passed.

Often, as in this case, the type of object returned can vary. In many cases the results on Quantopian are a Pandas Series or DataFrame or Panel object. Therefore one can use any of the associated Pandas methods. It's helpful to be very familiar with the those methods. See the docs for Pandas version 0.18 (which Quantopian uses) here.

Specifically, the rolling method is not an attribute of the prices function, but rather a method of the Pandas dataframe (or series) being returned. By using the help command one can see the attributes and methods specific to a given function (no need for getattr) however, the available methods are associated with the output object and are typically many many more.

Disclaimer

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.

Thanks, Dan. Both the 'help' and '?' methods are working. I tried the 'doc' method as well but that has some weird formatting. But the problem is essentially solved.