Messages.Python.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * 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.
*/
 
using System.IO;
using System.Runtime.CompilerServices;
using System.Collections.Generic;
 
using Python.Runtime;
using System;
using System.Linq;
 
namespace QuantConnect
{
    /// <summary>
    /// Provides user-facing message construction methods and static messages for the <see cref="Python"/> namespace
    /// </summary>
    public static partial class Messages
    {
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python"/> namespace classes
        /// </summary>
        public static class PythonCommon
        {
            /// <summary>
            /// Returns a string message saying the given attribute must be implemented on the given Python type
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string AttributeNotImplemented(string attribute, PyType pythonType)
            {
                return $"{attribute} must be implemented. Please implement this missing method on {pythonType}";
            }
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.MarginCallModelPythonWrapper"/> namespace classes
        /// </summary>
        public static class MarginCallModelPythonWrapper
        {
            /// <summary>
            /// String message saying: Must return a tuple, where the first item is a list and the second a boolean
            /// </summary>
            public static string GetMarginCallOrdersMustReturnTuple = "Must return a tuple, where the first item is a list and the second a boolean";
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.PandasConverter"/> namespace classes
        /// </summary>
        public static class PandasConverter
        {
            /// <summary>
            /// String message saying: Pandas module was not imported
            /// </summary>
            public static string PandasModuleNotImported = "pandas module was not imported.";
 
            /// <summary>
            /// Returns a string message saying ConvertToDictionary() method cannot be used to convert the given source
            /// type into the given target type. It also contains the reason why this method cannot be used
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string ConvertToDictionaryFailed(string sourceType, string targetType, string reason)
            {
                return $"ConvertToDictionary cannot be used to convert a {sourceType} into {targetType}. Reason: {reason}";
            }
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.PandasData"/> namespace classes
        /// </summary>
        public static class PandasData
        {
            /// <summary>
            /// Returns a string message saying the given key was duplicated in the given
            /// type class
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string DuplicateKey(string duplicateKey, string type)
            {
                return $"More than one '{duplicateKey}' member was found in '{type}' class.";
            }
 
            /// <summary>
            /// Returns a string message saying the given key does not exist in series dictionary
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string KeyNotFoundInSeries(string key)
            {
                return $"{key} key does not exist in series dictionary.";
            }
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.PythonInitializer"/> namespace classes
        /// </summary>
        public static class PythonInitializer
        {
            /// <summary>
            /// String message saying: start
            /// </summary>
            public static string Start = "start";
 
            /// <summary>
            /// String message saying: ended
            /// </summary>
            public static string Ended = "ended";
 
            /// <summary>
            /// Returns a string message saying it was impossible to find algorithm location path
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string UnableToLocateAlgorithm(string algorithmLocation)
            {
                return $"Unable to find algorithm location path: {algorithmLocation}.";
            }
 
            /// <summary>
            /// Returns a string message saying the given path to virtual environment does not exist
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string VirutalEnvironmentNotFound(string virtualEnvPath)
            {
                return $"Path {virtualEnvPath} to virtual environment does not exist.";
            }
 
            /// <summary>
            /// Returns a string message saying it was impossible to find system package configuration
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string FailedToFindSystemPackagesConfiguration(string virtualEnvPath, FileInfo configFile)
            {
                return $@"virtual env '{virtualEnvPath}'. Failed to find system packages configuration. ConfigFile.Exits: {
                    configFile.Exists}. Will default to true.";
            }
 
            /// <summary>
            /// Returns a string message saying the Python Initializer will use the system packages found
            /// in the virtual environment path
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string SystemPackagesConfigurationFound(string virtualEnvPath, bool includeSystemPackages)
            {
                return $"virtual env '{virtualEnvPath}'. Will use system packages: {includeSystemPackages}";
            }
 
            /// <summary>
            /// Returns a string message saying it was impossible to find the given python path
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string PythonPathNotFound(string pythonPath)
            {
                return $"Unable to find python path: {pythonPath}. Skipping.";
            }
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.PythonWrapper"/> namespace classes
        /// </summary>
        public static class PythonWrapper
        {
            /// <summary>
            /// String message saying: expected and interface type parameter
            /// </summary>
            public static string ExpectedInterfaceTypeParameter = "expected an interface type parameter.";
 
            /// <summary>
            /// Returns a string message saying the given interface must be fully implemented. It also advises the user
            /// on the missing methods in its interface
            /// </summary>
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InterfaceNotFullyImplemented(string interfaceName, string pythonTypeName, IEnumerable<string> missingMembers)
            {
                return $@"{interfaceName} must be fully implemented. Please implement these missing methods on {
                    pythonTypeName}: {string.Join(", ", missingMembers)}";
            }
        }
 
        /// <summary>
        /// Provides user-facing common messages for the <see cref="Python.BasePythonWrapper{TInterface}"/> class
        /// </summary>
        public static class BasePythonWrapper
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidDictionaryValueType(string pythonMethodName, Type expectedType, PyType actualPyType)
            {
                return InvalidDictionaryItemType(pythonMethodName, expectedType, actualPyType, isKey: false);
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidDictionaryKeyType(string pythonMethodName, Type expectedType, PyType actualPyType)
            {
                return InvalidDictionaryItemType(pythonMethodName, expectedType, actualPyType, isKey: true);
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidReturnTypeForMethodWithOutParameters(string pythonMethodName, PyType pyValueType)
            {
                return $"Invalid return type from method '{pythonMethodName.ToSnakeCase()}'. Expected a tuple type but was " +
                    $"'{GetPythonTypeName(pyValueType)}'. The tuple must contain the return value as the first item, " +
                    $"with the remaining ones being the out parameters.";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidReturnTypeTupleSizeForMethodWithOutParameters(string pythonMethodName, long expectedSize, long actualSize)
            {
                return $"Invalid return type from method '{pythonMethodName.ToSnakeCase()}'. Expected a tuple with at least " +
                    $"'{expectedSize}' items but only '{actualSize}' were returned. " +
                    $"The tuple must contain the return value as the first item, with the remaining ones being the out parameters.";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidOutParameterType(string pythonMethodName, int index, Type expectedType, PyType actualPyType)
            {
                return $"Invalid out parameter type in method '{pythonMethodName.ToSnakeCase()}'. Out parameter in position {index} " +
                    $"expected type is '{expectedType.Name}' but was '{GetPythonTypeName(actualPyType)}'.";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidReturnType(string pythonName, Type expectedType, PyType actualPyType, bool isMethod = true)
            {
                var message = isMethod
                    ? $"Invalid return type from method '{pythonName.ToSnakeCase()}'. "
                    : $"Invalid type for property '{pythonName.ToSnakeCase()}'. ";
                message += $"Expected a type convertible to '{expectedType.Name}' but was '{GetPythonTypeName(actualPyType)}'";
                return message;
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidIterable(string pythonMethodName, Type expectedType, PyType actualPyType)
            {
                return $"Invalid return type from method '{pythonMethodName.ToSnakeCase()}'. " +
                    $"Expected an iterable type of '{expectedType.Name}' items but was '{GetPythonTypeName(actualPyType)}'";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            public static string InvalidMethodIterableItemType(string pythonMethodName, Type expectedType, PyType actualPyType)
            {
                return $"Invalid return type from method '{pythonMethodName.ToSnakeCase()}'. Expected all the items in the iterator to be of type " +
                    $"'{expectedType.Name}' but found one of type ' {GetPythonTypeName(actualPyType)}'";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            private static string InvalidDictionaryItemType(string pythonMethodName, Type expectedType, PyType actualPyType, bool isKey = true)
            {
                return $"Invalid value type from method or property '{pythonMethodName.ToSnakeCase()}'. " +
                    $"Expected all the {(isKey ? "keys" : "values")} in the dictionary to be of type '{expectedType.Name}' " +
                    $"but found one of type '{GetPythonTypeName(actualPyType)}'";
            }
 
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            private static string GetPythonTypeName(PyType pyType)
            {
                return pyType.Name.Split('.').Last();
            }
        }
    }
}