Due to the new data method (#412), as_pandas is no longer necessary, as data provides more flexible options for accessing archive data, and it is also able to return dataframes by passing return_type="pandas".
This PR thus deprecates as_pandas. Because this is a fairly popular method, I have kept the method and raised a RuntimeError whenever it is called; however, I anticipate removing the method entirely in the future.
I also considered keeping as_pandas as an alias to data(return_type="pandas"), but this would require changing the parameters of as_pandas since data takes in fields rather than include_solutions and include_metadata. Removing as_pandas entirely makes it clear that it has been deprecated.
TODO
[x] Introduce a data() method that returns the archive data in many forms
[x] Remove as_pandas() since data(return_type="pandas") now fulfills this role
Description
Due to the new
datamethod (#412),as_pandasis no longer necessary, asdataprovides more flexible options for accessing archive data, and it is also able to return dataframes by passingreturn_type="pandas".This PR thus deprecates
as_pandas. Because this is a fairly popular method, I have kept the method and raised a RuntimeError whenever it is called; however, I anticipate removing the method entirely in the future.I also considered keeping
as_pandasas an alias todata(return_type="pandas"), but this would require changing the parameters ofas_pandassincedatatakes infieldsrather thaninclude_solutionsandinclude_metadata. Removingas_pandasentirely makes it clear that it has been deprecated.TODO
data()method that returns the archive data in many formsas_pandas()sincedata(return_type="pandas")now fulfills this roleQuestions
Status
yapfpytestpylintHISTORY.md