Source code for google_pandas_load.loader_quick_setup

import logging
from google.cloud import bigquery, storage
from google_pandas_load.loader import Loader

not_propagating_logger = logging.getLogger(name='LoaderQuickSetup')
not_propagating_logger.setLevel(level=logging.DEBUG)
not_propagating_logger.propagate = False
ch = logging.StreamHandler()
fmt = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
formatter = logging.Formatter(fmt=fmt)
ch.setFormatter(fmt=formatter)
not_propagating_logger.addHandler(hdlr=ch)


class LoaderQuickSetup(Loader):
    """
    The purpose of this class is to quickly set up a loader.

    An instance of LoaderQuickSetup is simply an instance of the base class
    built with the following arguments:

    ::

         bq_client=bq_client
         dataset_ref=dataset_ref
         bucket=bucket
         gs_dir_path=gs_dir_path
         local_dir_path=local_dir_path
         separator=separator
         chunk_size=chunk_size
         logger=logger

    where

    ::

        bq_client = google.cloud.bigquery.Client(
            project=project_id,
            credentials=credentials)
        dataset_ref = google.cloud.bigquery.DatasetReference(
            project=project_id,
            dataset_id=dataset_name)
        gs_client = google.cloud.storage.Client(
            project=project_id,
            credentials=credentials)
        bucket = google.cloud.storage.Bucket(
            client=gs_client,
            name=bucket_name)

    Args:
        project_id (str, optional): The project id.
        dataset_name (str, optional): The dataset name.
        bucket_name (str, optional): The bucket name.
        gs_dir_path (str, optional): See base class.
        credentials (google.auth.credentials.Credentials): Credentials used to
            build the bq_client and the bucket. If not passed, falls back to
            the default inferred from the environment.
        local_dir_path (str, optional): See base class.
        separator (str, optional): See base class.
        chunk_size (int, optional): See base class.
        logger (logging.Logger, optional): See base class. Default value is a
            logger called LoaderQuickSetup. Contrary to the default base class
            logger, it is set to not propagate its log records to its logger
            ancestors and it is equipped with an handler displaying the log
            records to the console. This is, for instance, convenient when
            working with a notebook.
    """

    def __init__(
            self,
            project_id=None,
            dataset_name=None,
            bucket_name=None,
            gs_dir_path=None,
            credentials=None,
            local_dir_path=None,
            separator='|',
            chunk_size=2 ** 28,
            logger=not_propagating_logger):
        self._project_id = project_id
        bq_client = None
        dataset_ref = None
        self._gs_client = None
        bucket = None
        if self._project_id is not None:
            bq_client = bigquery.Client(
                project=self._project_id, credentials=credentials)
            if dataset_name is not None:
                dataset_ref = bigquery.DatasetReference(
                    project=self._project_id, dataset_id=dataset_name)
            if bucket_name is not None:
                self._gs_client = storage.Client(
                    project=self._project_id, credentials=credentials)
                bucket = storage.Bucket(
                    client=self._gs_client, name=bucket_name)

        super().__init__(
            bq_client=bq_client,
            dataset_ref=dataset_ref,
            bucket=bucket,
            gs_dir_path=gs_dir_path,
            local_dir_path=local_dir_path,
            separator=separator,
            chunk_size=chunk_size,
            logger=logger)

    @property
    def project_id(self):
        """str: The project_id given in the argument."""
        return self._project_id

    @property
    def gs_client(self):
        """google.cloud.storage.client.Client: The Storage client used to
        create the bucket."""
        return self._gs_client