Операции с файлами

Пользователи платформы выражают обоснованную обеспокоенность по поводу запуска сиБотов и индикаторов с AccessRights.FullAccess. Это особенно актуально, когда исходный код недоступен, трудно точно знать, какие изменения будут внесены алгоритмом в файловую систему. В руководстве по правам доступа мы уже рекомендовали, чтобы сиБоты и индикаторы, которыми вы делитесь с другими, получали AccessRights.None.

Это руководство по API объясняет, как алгоритмы с ограниченными AccessRights могут безопасно выполнять операции с локальными файлами.

Правила операций с файлами

Любому алгоритму с ограниченными правами доступа разрешено выполнять операции с файлами только в выделенной папке файловой системы пользователя. Каждый тип алгоритма размещает свою собственную папку, как показано ниже (например, сиБоты и индикаторы), при этом для каждого имени алгоритма создается отдельная папка.

Documents
|-cAlgo
  |-Data
    |-cBots
      |-${cBot Name}
    |-Indicators
      |-${Indicator Name}

Следующие правила определяют, как функция операций с файлами работает в API:

1. Каждый алгоритм имеет доступ только к папке, соответствующей его имени (включая подпапки, если таковые имеются).

2. Если соответствующей папки нет, такая папка создается в файловой системе согласно приведенной выше схеме при первом запуске экземпляра.

3. Если новую папку невозможно создать, сиБот или индикатор не запустится, и будет сообщено об ошибке.

4. В коде алгоритма вам не нужно указывать полный путь к соответствующей папке. Вместо этого алгоритмы используют относительный путь.

5. Пространство имен System.IO предлагает множество классов (File, FileInfo, Directory. DirectoryInfo, Path и т. д.) для которых можно вызывать соответствующие методы для выполнения операций с файлами и папками.

Ниже приведены некоторые примеры методов, включенных в классы File и Directory.

Пример создания сиБота

В приведенном ниже примере сиБот имеет AccessRights.None, но создает текстовый файл в соответствующей папке с именем "File Access Test" сразу после инициализации. Если рыночный ордер успешно размещен в OnStart(), сиБот записывает идентификатор позиции в созданный файл.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;
using System.IO;

namespace cAlgo.Robots
{
    [Robot(TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
    public class MycBot : Robot
    {
        protected override void OnStart()
        {
            TradeResult result = ExecuteMarketOrder(TradeType.Buy, SymbolName, 1000);

            if (result.IsSuccessful)
            {
                string positionId = result.Position.Id.ToString();
                {
                    File.WriteAllText("My positions.txt", $"{positionId}");
                } 
            }
        }
    }
}

Параметр File

Тип параметра File позволяет алгоритмам принимать файлы от пользователей через API. Он дает алгоритмам возможность безопасно читать данные из выбранного пользователем файла на локальной машине и записывать их в него.

При определении в алгоритме:

• В пользовательском интерфейсе cTrader параметр отображается как текстовое поле с кнопкой Обзор, которая открывает диалоговое окно выбора файла.
• В cTrader CLI пользователи могут передать путь к файлу непосредственно в качестве значения параметра.
• Алгоритм получает строго типизированный объект File со встроенными методами чтения и записи.

Тип параметра File можно использовать для выполнения следующих операций в алгоритмах:

Чтобы определить параметр файла, объявите свойство типа File и добавьте к нему атрибут [Parameter].

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

using cAlgo.API;

namespace cAlgo.Robots;

[Robot(AccessRights = AccessRights.None)]
public class FileParameterTypeTest : Robot
{
    [Parameter(DefaultValue = @"C:\Data\input.txt")]
    public File DataFile { get; set; }

    protected override void OnStart()
    {
        Print($"Exists: {DataFile.Exists()}");
    }
}

Вы можете прочитать весь файл как текст или как отдельные строки.

1
2

var text = DataFile.ReadAllText();
var lines = DataFile.ReadLines();

Операции записи перезаписывают существующее содержимое файла.

1

DataFile.WriteAllText("This is a test", EncodingType.Ascii);

Вы можете добавлять текст или несколько строк без перезаписи существующего содержимого.

1
2

DataFile.AppendAllText("This is a test", EncodingType.Utf8);
DataFile.AppendAllLines(new[] { "Line 1", "Line 2" }, EncodingType.Utf8);

Перед выполнением операций вы можете проверить, существует ли файл.

1
2
3
4

if (DataFile.Exists())
{
    Print("File is available");
}

Обзор

Функция работы с файлами в API по-прежнему позволяет алгоритмам с ограниченными правами доступа работать с локальными файлами и папками. Вы можете использовать методы из пространства имен System.IO языка C# для программирования того, как алгоритмы будут выполнять такие операции в пределах соответствующей папки. Таким образом, другие директории в файловой системе пользователя остаются полностью защищенными, даже если исходный код алгоритма недоступен.