Source code for casinotools.file_format.casino2.file

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
.. py:currentmodule:: casinotools.file_format.casino2.file

.. moduleauthor:: Hendrix Demers <hendrix.demers@mail.mcgill.ca>

CASINO file structure: either sim or .cas.
"""

###############################################################################
# Copyright 2017 Hendrix Demers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
###############################################################################

# Standard library modules.
import logging
import os.path

# Third party modules.

# Local modules.

# Project modules.
from casinotools.file_format.file_reader_writer_tools import read_int
from casinotools.file_format.tags import find_tag
from casinotools.file_format.tags import limited_search_tag, TAG_LENGTH
from casinotools.file_format.casino2.simulation_data import SimulationData, TAG_VERSION
from casinotools.file_format.casino2.version import UNKNOWN_VERSION

# Globals and constants variables.
SAVEFILE_HEADER_MAXCHAR = 1024




class File:
    def __init__(self):
        self._filepath = None
        self._optionSimulationData = None
        self._numberSimulations = 0
        self._resultSimulationDataList = []



    def read_from_filepath(self, filepath, is_skip_reading_data=False):
        """
        Read the casino either .sim or .cas file.

        :param filepath: complete filepath to read.
        :param is_skip_reading_data:
        """
        self._filepath = filepath

        file = open(self._filepath, 'rb')
        self.read_from_file_object(file, is_skip_reading_data)




    def read_from_file_object(self, file, is_skip_reading_data=False):
        assert getattr(file, 'mode', 'rb') == 'rb'

        file.seek(0)
        # Read the first part of the file corresponding to the option of the simulation.
        # Common to the .sim and .cas files.
        self._optionSimulationData = SimulationData(is_skip_reading_data)
        self._optionSimulationData.read(file)

        logging.debug("File position after reading option: %i", file.tell())

        # Read the results for each simulations if the file is a .cas.
        if self._optionSimulationData.save_trajectories:
            self._numberSimulations = read_int(file)

            for dummy in range(self._numberSimulations):
                simulation_data = SimulationData(is_skip_reading_data)
                simulation_data.read(file)
                self._resultSimulationDataList.append(simulation_data)

        file.close()




    def write(self, filepath):
        if self._optionSimulationData is not None:
            self._filepath = filepath

            if self._is_simulation_filepath(self._filepath):
                logging.info("Create CASINO file: %s", self._filepath)

                file = open(self._filepath, 'wb')
                assert getattr(file, 'mode', 'wb') == 'wb'
                file.seek(0)
                self._optionSimulationData.write(file)
                file.close()
        else:
            raise AttributeError("No option simulation data specified.")




    @staticmethod
    def _is_simulation_filepath(filepath):
        extension = os.path.splitext(filepath)[1]

        return extension.lower() == '.sim'




    def set_option_simulation_data(self, option_simulation_data):
        self._optionSimulationData = option_simulation_data




    def get_option_simulation_data(self):
        return self._optionSimulationData




    def get_number_simulations(self):
        return len(self._resultSimulationDataList)




    def get_results_first_simulation(self):
        return self._resultSimulationDataList[0]




    def get_results_simulation(self, index):
        return self._resultSimulationDataList[index]




    def extract_version(self, file_path):
        version = UNKNOWN_VERSION

        with open(file_path, 'rb') as casino_file:
            casino_file.seek(0)

            tag_id = TAG_VERSION
            if limited_search_tag(casino_file, tag_id, SAVEFILE_HEADER_MAXCHAR, TAG_LENGTH):
            # if find_tag(casino_file, tag_id):
                logging.debug("File pos: %i", casino_file.tell())
                version = read_int(casino_file)

        return version






def _run():
    from pkg_resources import resource_filename  # @UnresolvedImport
    file_path_cas = resource_filename(__file__, "../../test_data/wincasino2.45/v2.4.6.1/id475_v2.46.cas")
    file = File()
    file.read_from_filepath(file_path_cas, is_skip_reading_data=True)





def run_profile():
    import cProfile
    cProfile.run('_run()', 'Casino2.x_File.prof')





def run_profile2():
    try:
        import hotshot
    except ImportError:  # hotshot not supported in Python 3
        return

    prof = hotshot.Profile("Casino2.x_File.prof", lineevents=1)
    prof.runcall(_run)
    prof.close()



if __name__ == '__main__':  # pragma: no cover
    run_profile()