LocobjectRetriever

LocobjectRetriever Class Documentation

Overview

The LocobjectRetriever class in the openmindat package is designed for querying locality object data from the Mindat API by Id. The class supports method chaining for flexible query building and provides functionalities to save the queried data.

Usage

Create an instance of the LocobjectRetriever class and use its methods to set up your search Id and retrieve data.

Example

from openmindat import LocobjectRetriever

lor = LocobjectRetriever()
lor.id(12).saveto("/path/to/directory", "Locobj_12")

Methods

id(ID)

Declares Id to search for.

• ID (int): specified Id.
• Returns: self
• Example Usage:

  lor.id(12)

saveto(OUTDIR, FILE_NAME)

Executes the query and saves the results to a specified directory.

• OUTDIR (str): Directory path.
• FILE_NAME (str): file name.
• Returns: None

save(FILE_NAME)

Executes the query and saves the results to the current directory.

• FILE_NAME (str): file name
• Returns: None

get_dict()

Executes the query and saves the results to an object.

• Returns: Dictionary

Additional Information

For more details, please refer to the Mindat API documentation.

Back to Top