delta-barth/delta-barth-cs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 3 Releases 1 Wiki Activity

add debug method to look for relevant paths, related to delta-barth/delta-barth-py#33

Browse Source
This commit is contained in:
Florian Förster 2025-06-11 11:40:12 +02:00
parent fd86abd872
commit 3af9c4fc6d
3 changed files with 357 additions and 328 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

409
dopt.DeltaBarth.Tests/PluginTest.cs
View File

@ -40,22 +40,22 @@ namespace dopt.DeltaBarth.Tests
{ {
private const string absPath = @"A:\Arbeitsaufgaben\Delta-Barth\cs-wrapper\dopt.DeltaBarth"; private const string absPath = @"A:\Arbeitsaufgaben\Delta-Barth\cs-wrapper\dopt.DeltaBarth";
public TPlugin() : base(absPath) { } public TPlugin() : base(absPath) { }
public new DataObjects.Credentials GetCredentials() //public new DataObjects.Credentials GetCredentials()
{ //{
return base.GetCredentials(); // return base.GetCredentials();
} //}
public new string GetBaseApiUrl() //public new string GetBaseApiUrl()
{ //{
return base.GetBaseApiUrl(); // return base.GetBaseApiUrl();
} //}
public new string GetDataPath() //public new string GetDataPath()
{ //{
return base.GetDataPath(); // return base.GetDataPath();
} //}
public new void Setup(string datenPfad, string basisApiUrl) //public new void Setup(string datenPfad, string basisApiUrl)
{ //{
base.Setup(datenPfad, basisApiUrl); // base.Setup(datenPfad, basisApiUrl);
} //}
} }
[TestClass] [TestClass]
public sealed class PluginTest public sealed class PluginTest
@ -78,194 +78,201 @@ namespace dopt.DeltaBarth.Tests
test.Dispose(); test.Dispose();
} }
[TestMethod] [TestMethod]
public void Set_and_Obtain_Credentials_Test() public void DebugCall_Test()
{ {
var test = new TPlugin(); var test = new TPlugin();
string user = "user", password = "password", database = "DB1", mandant = "mandant1"; test.DebugCall();
test.SetzeNutzerdaten(user, password, database, mandant);
var creds = test.GetCredentials();
PrettyPrint(creds);
Assert.AreEqual(user, creds.username);
Assert.AreEqual(password, creds.password);
Assert.AreEqual(database, creds.database);
Assert.AreEqual(mandant, creds.mandant);
test.Dispose();
}
[TestMethod]
public void SetupSession_Test()
{
var test = new TPlugin();
string apiUrlSet = "http://10.2.22.21:8080/api/";
test.Setup(baseDataPath, apiUrlSet);
// data path
var dataPathGet = test.GetDataPath();
Console.WriteLine($"Result for data path from Python session was: {dataPathGet}");
bool pathElementsContained = dataPathGet.Contains("test_data_path");
Assert.IsTrue(pathElementsContained);
// API URL
var apiUrlGet = test.GetBaseApiUrl();
Console.WriteLine($"Result for API URL from Python session was: {apiUrlGet}");
Assert.AreEqual(apiUrlSet, apiUrlGet);
test.Dispose();
}
[TestMethod]
public void Startup_Test()
{
var test = new TPlugin();
string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var apiUrlGet = test.GetBaseApiUrl();
var creds = test.GetCredentials();
Console.WriteLine($"Result from Python session was: API-URL={apiUrlGet}, creds={creds}");
PrettyPrint(creds);
Assert.AreEqual(apiUrlSet, apiUrlGet);
Assert.AreEqual(user, creds.username);
Assert.AreEqual(password, creds.password);
Assert.AreEqual(database, creds.database);
Assert.AreEqual(mandant, creds.mandant);
test.Dispose();
}
[TestMethod]
public void UmsatzprognoseDummy_WithoutParams_Test()
{
var test = new TPlugin();
string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var res = test.UmsatzprognoseDummy(null, null);
PrettyPrint(res);
Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
test.Dispose();
}
[TestMethod]
public void UmsatzprognoseDummy_WithCompanyIdWithoutDate_Test()
{
var test = new TPlugin();
string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var comp_id = 1000;
var res = test.UmsatzprognoseDummy(comp_id, null);
PrettyPrint(res);
Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
test.Dispose();
}
[TestMethod]
public void UmsatzprognoseDummy_WithoutCompanyIdWithDate_Test()
{
var test = new TPlugin();
string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2023, 1, 1, 12, 45, 30);
var res = test.UmsatzprognoseDummy(null, date);
PrettyPrint(res);
Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
test.Dispose();
}
[TestMethod]
public void Umsatzprognose_NoConnectionNeeded_Test()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2030, 1, 1, 12, 45, 30);
var res = test.Umsatzprognose(null, date);
PrettyPrint(res);
test.Dispose();
}
[TestMethod]
[TestCategory("ActiveAPI")]
public void Umsatzprognose_WithCompanyIdWithDate_Test()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2023, 8, 15, 12, 45, 30);
List<int> comp_id = new List<int> { 1027, 5661, 1024 };
var res = test.Umsatzprognose(comp_id, date);
PrettyPrint(res);
Assert.AreEqual(4, res.status.code);
Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeMonatsdatenpunkte, res.status.code);
test.Dispose();
}
[TestMethod]
[TestCategory("ActiveAPI")]
public void Umsatzprognose_WithCompanyIdWithoutDate_Test()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
List<int> comp_id = new List<int> { 5661 };
var res = test.Umsatzprognose(comp_id, null);
PrettyPrint(res);
Assert.AreEqual(4, res.status.code);
Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeMonatsdatenpunkte, res.status.code);
test.Dispose();
}
[TestMethod]
public void Umsatzprognose_WithCompanyIdWithoutDate_Test_FailConnection()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
List<int> comp_id = new List<int> { 5661 };
var res = test.Umsatzprognose(comp_id, null);
PrettyPrint(res);
Assert.AreEqual(1, res.status.code);
Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
test.Dispose();
}
[TestMethod]
[TestCategory("ActiveAPI")]
public void Umsatzprognose_WithoutCompanyIdWithInvalidDate_Test()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2030, 1, 1, 12, 45, 30);
var res = test.Umsatzprognose(null, date);
PrettyPrint(res);
Assert.AreEqual(3, res.status.code);
Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeDatenpunkte, res.status.code);
test.Dispose();
}
[TestMethod]
public void Umsatzprognose_WithoutCompanyIdWithInvalidDate_Test_FailConnection()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2030, 1, 1, 12, 45, 30);
var res = test.Umsatzprognose(null, date);
PrettyPrint(res);
Assert.AreEqual(1, res.status.code);
Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
test.Dispose();
}
[TestMethod]
[TestCategory("ActiveAPI")]
public void Umsatzprognose_WithoutCompanyIdWithValidDate_Test()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2021, 1, 1, 12, 45, 30);
var res = test.Umsatzprognose(null, date);
PrettyPrint(res);
Assert.AreEqual(0, res.status.code);
Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
test.Dispose();
}
[TestMethod]
public void Umsatzprognose_WithoutCompanyIdWithValidDate_Test_FailConnection()
{
var test = new TPlugin();
string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
var date = new DateTime(2015, 1, 1, 12, 45, 30);
var res = test.Umsatzprognose(null, date);
PrettyPrint(res);
Assert.AreEqual(1, res.status.code);
Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
test.Dispose(); test.Dispose();
} }
//[TestMethod]
//public void Set_and_Obtain_Credentials_Test()
//{
// var test = new TPlugin();
// string user = "user", password = "password", database = "DB1", mandant = "mandant1";
// test.SetzeNutzerdaten(user, password, database, mandant);
// var creds = test.GetCredentials();
// PrettyPrint(creds);
// Assert.AreEqual(user, creds.username);
// Assert.AreEqual(password, creds.password);
// Assert.AreEqual(database, creds.database);
// Assert.AreEqual(mandant, creds.mandant);
// test.Dispose();
//}
//[TestMethod]
//public void SetupSession_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = "http://10.2.22.21:8080/api/";
// test.Setup(baseDataPath, apiUrlSet);
// // data path
// var dataPathGet = test.GetDataPath();
// Console.WriteLine($"Result for data path from Python session was: {dataPathGet}");
// bool pathElementsContained = dataPathGet.Contains("test_data_path");
// Assert.IsTrue(pathElementsContained);
// // API URL
// var apiUrlGet = test.GetBaseApiUrl();
// Console.WriteLine($"Result for API URL from Python session was: {apiUrlGet}");
// Assert.AreEqual(apiUrlSet, apiUrlGet);
// test.Dispose();
//}
//[TestMethod]
//public void Startup_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var apiUrlGet = test.GetBaseApiUrl();
// var creds = test.GetCredentials();
// Console.WriteLine($"Result from Python session was: API-URL={apiUrlGet}, creds={creds}");
// PrettyPrint(creds);
// Assert.AreEqual(apiUrlSet, apiUrlGet);
// Assert.AreEqual(user, creds.username);
// Assert.AreEqual(password, creds.password);
// Assert.AreEqual(database, creds.database);
// Assert.AreEqual(mandant, creds.mandant);
// test.Dispose();
//}
//[TestMethod]
//public void UmsatzprognoseDummy_WithoutParams_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var res = test.UmsatzprognoseDummy(null, null);
// PrettyPrint(res);
// Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void UmsatzprognoseDummy_WithCompanyIdWithoutDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var comp_id = 1000;
// var res = test.UmsatzprognoseDummy(comp_id, null);
// PrettyPrint(res);
// Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void UmsatzprognoseDummy_WithoutCompanyIdWithDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = "http://10.2.22.21:8080/api/", user = "user", password = "password", database = "DB1", mandant = "mandant1";
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2023, 1, 1, 12, 45, 30);
// var res = test.UmsatzprognoseDummy(null, date);
// PrettyPrint(res);
// Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void Umsatzprognose_NoConnectionNeeded_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2030, 1, 1, 12, 45, 30);
// var res = test.Umsatzprognose(null, date);
// PrettyPrint(res);
// test.Dispose();
//}
//[TestMethod]
//[TestCategory("ActiveAPI")]
//public void Umsatzprognose_WithCompanyIdWithDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2023, 8, 15, 12, 45, 30);
// List<int> comp_id = new List<int> { 1027, 5661, 1024 };
// var res = test.Umsatzprognose(comp_id, date);
// PrettyPrint(res);
// Assert.AreEqual(4, res.status.code);
// Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeMonatsdatenpunkte, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//[TestCategory("ActiveAPI")]
//public void Umsatzprognose_WithCompanyIdWithoutDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// List<int> comp_id = new List<int> { 5661 };
// var res = test.Umsatzprognose(comp_id, null);
// PrettyPrint(res);
// Assert.AreEqual(4, res.status.code);
// Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeMonatsdatenpunkte, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void Umsatzprognose_WithCompanyIdWithoutDate_Test_FailConnection()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// List<int> comp_id = new List<int> { 5661 };
// var res = test.Umsatzprognose(comp_id, null);
// PrettyPrint(res);
// Assert.AreEqual(1, res.status.code);
// Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//[TestCategory("ActiveAPI")]
//public void Umsatzprognose_WithoutCompanyIdWithInvalidDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2030, 1, 1, 12, 45, 30);
// var res = test.Umsatzprognose(null, date);
// PrettyPrint(res);
// Assert.AreEqual(3, res.status.code);
// Assert.AreEqual((int)StatusCodes.DatensatzZuWenigeDatenpunkte, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void Umsatzprognose_WithoutCompanyIdWithInvalidDate_Test_FailConnection()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2030, 1, 1, 12, 45, 30);
// var res = test.Umsatzprognose(null, date);
// PrettyPrint(res);
// Assert.AreEqual(1, res.status.code);
// Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//[TestCategory("ActiveAPI")]
//public void Umsatzprognose_WithoutCompanyIdWithValidDate_Test()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2021, 1, 1, 12, 45, 30);
// var res = test.Umsatzprognose(null, date);
// PrettyPrint(res);
// Assert.AreEqual(0, res.status.code);
// Assert.AreEqual((int)StatusCodes.Erfolg, res.status.code);
// test.Dispose();
//}
//[TestMethod]
//public void Umsatzprognose_WithoutCompanyIdWithValidDate_Test_FailConnection()
//{
// var test = new TPlugin();
// string apiUrlSet = config.apiUrl, user = config.username, password = config.password, database = config.database, mandant = config.mandant;
// test.Startup(baseDataPath, apiUrlSet, user, password, database, mandant);
// var date = new DateTime(2015, 1, 1, 12, 45, 30);
// var res = test.Umsatzprognose(null, date);
// PrettyPrint(res);
// Assert.AreEqual(1, res.status.code);
// Assert.AreEqual((int)StatusCodes.VerbindungTimeout, res.status.code);
// test.Dispose();
//}
} }
} }

276
dopt.DeltaBarth/Plugin.cs
View File

@ -88,6 +88,10 @@ namespace dopt.DeltaBarth
/// </summary> /// </summary>
protected dynamic pyModPipeline; protected dynamic pyModPipeline;
/// <summary> /// <summary>
/// Debug-Modul für Python-Umgebung
/// </summary>
protected dynamic pyDebug;
/// <summary>
/// Konstruktor der Plugin-Klasse. /// Konstruktor der Plugin-Klasse.
/// Kann mit beliebigem Pfad zu einer Python-Runtime initialisiert werden. /// Kann mit beliebigem Pfad zu einer Python-Runtime initialisiert werden.
/// </summary> /// </summary>
@ -100,141 +104,159 @@ namespace dopt.DeltaBarth
{ {
pyModManagement = Py.Import("delta_barth.management"); pyModManagement = Py.Import("delta_barth.management");
pyModPipeline = Py.Import("delta_barth.pipelines"); pyModPipeline = Py.Import("delta_barth.pipelines");
pyDebug = Py.Import("delta_barth._debug");
} }
} }
/// <summary> /// <summary>
/// Initialisiert das Plugin mit allen relevanten Paramtern für die weitere Nutzung. /// Gibt Runtime-relevante Pfade in der Konsole aus
/// Diese Methode sollte nur einmal je Instanz genutzt werden.
/// </summary> /// </summary>
/// <param name="datenPfad">Pfad zu einem Ordner, in dem Programmdaten ohne Bedenken dauerhaft abgelegt werden können.</param> public string DebugCall()
/// <param name="basisApiUrl">Basis-URL zum Zugriff auf die API. Dies muss eine vollständige URL sein inkl. der Route "/api".</param>
/// <param name="nutzername">Nutzername für die Datenbankanmeldung.</param>
/// <param name="passwort">Passwort für die Datenbankanmeldung.</param>
/// <param name="datenbank">Name der Datenbank, bei der die Anmeldung erfolgen soll.</param>
/// <param name="mandant">Mandant für die Datenbankanmeldung.</param>
public void Startup(string datenPfad, string basisApiUrl, string nutzername, string passwort, string datenbank, string mandant)
{ {
AssertNotDisposed(); string infos;
Setup(datenPfad, basisApiUrl);
SetzeNutzerdaten(nutzername, passwort, datenbank, mandant);
}
/// <summary>
/// Diese Methode erlaubt es, die relevanten Nutzerdaten zur Laufzeit des Plugins zu ändern.
/// Dies beinhaltet: Nutzername, Passwort, Datenbankname, Mandant
/// </summary>
/// <param name="nutzername">Nutzername für die Datenbankanmeldung.</param>
/// <param name="passwort">Passwort für die Datenbankanmeldung.</param>
/// <param name="datenbank">Name der Datenbank, bei der die Anmeldung erfolgen soll.</param>
/// <param name="mandant">Mandant für die Datenbankanmeldung.</param>
public void SetzeNutzerdaten(string nutzername, string passwort, string datenbank, string mandant)
{
AssertNotDisposed();
using (Py.GIL()) {
pyModManagement.set_credentials(nutzername, passwort, datenbank, mandant);
}
}
/// <summary>
/// Ausführung der Umsatzprognose-Pipeline mit Dummy-Daten.
/// Es werden keine API-Abrufe durchgeführt und somit auch keine Live-Daten genutzt.
/// </summary>
/// <param name="firmaId">optional: Firmen-ID, für die die Pipeline ausgeführt werden soll.
/// Wird der Parameter nicht zur Verfügung gestellt, werden alle Firmen bzw. Kunden abgerufen</param>
/// <param name="analyseBeginn">optional: Start-Datum, ab dem die Daten für die Erstellung des Prognosemodells genutzt werden.
/// Daten, die weiter in der Vergangenheit liegen, werden nicht berücksichtigt.
/// Wird der Parameter nicht zur Verfügung gestellt, wird die gesamte Historie genutzt.</param>
/// <returns cref="DataObjects.UmsatzPrognoseAusgabe">Umsatzprognose inkl. Status-Objekt zur Nachvollziehbarkeit etwaig aufgetretener Fehler.</returns>
/// <exception cref="PythonParsingException"></exception>
public DataObjects.UmsatzPrognoseAusgabe UmsatzprognoseDummy(int? firmaId, DateTime? analyseBeginn)
{
AssertNotDisposed();
string pyJson;
using (Py.GIL()) using (Py.GIL())
{ {
pyJson = pyModPipeline.pipeline_sales_forecast_dummy(firmaId, analyseBeginn);
}
var parsed = JsonSerializer.Deserialize<DataObjects.UmsatzPrognoseAusgabe>(pyJson) ?? throw new PythonParsingException("Could not correctly parse object from Python");
return parsed;
}
/// <summary>
/// Ausführung der Umsatzprognose-Pipeline mit Live-Daten.
/// Es werden API-Abrufe durchgeführt und somit auch Live-Daten genutzt.
/// Hierfür muss sichergestellt sein, dass der API-Server erreichbar und abrufbereit ist.
/// </summary>
/// <param name="firmaIds">optional: Liste von Firmen-IDs, für die die Pipeline ausgeführt werden soll.
/// Wird der Parameter nicht zur Verfügung gestellt, werden alle Firmen bzw. Kunden abgerufen</param>
/// <param name="analyseBeginn">optional: Start-Datum, ab dem die Daten für die Erstellung des Prognosemodells genutzt werden.
/// Daten, die weiter in der Vergangenheit liegen, werden nicht berücksichtigt.
/// Wird der Parameter nicht zur Verfügung gestellt, wird die gesamte Historie genutzt.</param>
/// <returns cref="DataObjects.UmsatzPrognoseAusgabe">Umsatzprognose inkl. Status-Objekt zur Nachvollziehbarkeit etwaig aufgetretener Fehler.</returns>
/// <exception cref="PythonParsingException"></exception>
public DataObjects.UmsatzPrognoseAusgabe Umsatzprognose(List<int>? firmaIds, DateTime? analyseBeginn)
{
AssertNotDisposed();
string pyJson;
using (Py.GIL())
{
pyJson = pyModPipeline.pipeline_sales_forecast(firmaIds, analyseBeginn);
}
var parsed = JsonSerializer.Deserialize<DataObjects.UmsatzPrognoseAusgabe>(pyJson) ?? throw new PythonParsingException("Could not correctly parse object from Python");
return parsed;
}
/// <summary>
/// Setup der Python-internen Umgebung
/// </summary>
/// <param name="datenPfad">Pfad zu einem Ordner, in dem Programmdaten ohne Bedenken dauerhaft abgelegt werden können.</param>
/// <param name="basisApiUrl">Basis-URL zum Zugriff auf die API. Dies muss eine vollständige URL sein inkl. der Route "/api".</param>
protected void Setup(string datenPfad, string basisApiUrl)
{
AssertNotDisposed();
using (Py.GIL())
{
pyModManagement.setup(datenPfad, basisApiUrl);
}
}
/// <summary>
/// Hole die konfigurierte API-Basis-URL aus der Python-Umgebung
/// </summary>
/// <returns>konfigurierte Basis-URL</returns>
protected string GetBaseApiUrl()
{
AssertNotDisposed();
string pyJson;
using (Py.GIL())
{
pyJson = (string)pyModManagement.get_base_url();
}
return pyJson;
}
/// <summary>
/// Hole den konfigurierten Datenpfad zur Dateiverwaltung aus der Python-Umgebung
/// </summary>
/// <returns>konfigurierten Datenpfad</returns>
protected string GetDataPath()
{
AssertNotDisposed();
string pyJson;
using (Py.GIL())
{
pyJson = (string)pyModManagement.get_data_path();
}
return pyJson;
}
/// <summary>
/// Hole die konfigurierten Nutzerdaten zur API-Interaktion aus der Python-Umgebung
/// </summary>
/// <returns cref="DataObjects.Credentials">konfigurierte Nutzerdaten</returns>
/// <exception cref="PythonParsingException"></exception>
protected DataObjects.Credentials GetCredentials()
{
AssertNotDisposed();
string pyJson;
using (Py.GIL())
{
pyJson = (string)pyModManagement.get_credentials();
}
DataObjects.Credentials? parsed = JsonSerializer.Deserialize<DataObjects.Credentials>(pyJson); infos = pyDebug.print_infos();
return parsed ?? throw new PythonParsingException("Could not correctly parse object from Python");
} }
Console.WriteLine(infos);
Console.WriteLine($"PyEngine - PYHOME: {PythonEngine.PythonHome}");
Console.WriteLine($"PyEngine - PYPATH: {PythonEngine.PythonPath}");
return infos;
}
///// <summary>
///// Initialisiert das Plugin mit allen relevanten Paramtern für die weitere Nutzung.
///// Diese Methode sollte nur einmal je Instanz genutzt werden.
///// </summary>
///// <param name="datenPfad">Pfad zu einem Ordner, in dem Programmdaten ohne Bedenken dauerhaft abgelegt werden können.</param>
///// <param name="basisApiUrl">Basis-URL zum Zugriff auf die API. Dies muss eine vollständige URL sein inkl. der Route "/api".</param>
///// <param name="nutzername">Nutzername für die Datenbankanmeldung.</param>
///// <param name="passwort">Passwort für die Datenbankanmeldung.</param>
///// <param name="datenbank">Name der Datenbank, bei der die Anmeldung erfolgen soll.</param>
///// <param name="mandant">Mandant für die Datenbankanmeldung.</param>
//public void Startup(string datenPfad, string basisApiUrl, string nutzername, string passwort, string datenbank, string mandant)
//{
// AssertNotDisposed();
// Setup(datenPfad, basisApiUrl);
// SetzeNutzerdaten(nutzername, passwort, datenbank, mandant);
//}
///// <summary>
///// Diese Methode erlaubt es, die relevanten Nutzerdaten zur Laufzeit des Plugins zu ändern.
///// Dies beinhaltet: Nutzername, Passwort, Datenbankname, Mandant
///// </summary>
///// <param name="nutzername">Nutzername für die Datenbankanmeldung.</param>
///// <param name="passwort">Passwort für die Datenbankanmeldung.</param>
///// <param name="datenbank">Name der Datenbank, bei der die Anmeldung erfolgen soll.</param>
///// <param name="mandant">Mandant für die Datenbankanmeldung.</param>
//public void SetzeNutzerdaten(string nutzername, string passwort, string datenbank, string mandant)
//{
// AssertNotDisposed();
// using (Py.GIL()) {
// pyModManagement.set_credentials(nutzername, passwort, datenbank, mandant);
// }
//}
///// <summary>
///// Ausführung der Umsatzprognose-Pipeline mit Dummy-Daten.
///// Es werden keine API-Abrufe durchgeführt und somit auch keine Live-Daten genutzt.
///// </summary>
///// <param name="firmaId">optional: Firmen-ID, für die die Pipeline ausgeführt werden soll.
///// Wird der Parameter nicht zur Verfügung gestellt, werden alle Firmen bzw. Kunden abgerufen</param>
///// <param name="analyseBeginn">optional: Start-Datum, ab dem die Daten für die Erstellung des Prognosemodells genutzt werden.
///// Daten, die weiter in der Vergangenheit liegen, werden nicht berücksichtigt.
///// Wird der Parameter nicht zur Verfügung gestellt, wird die gesamte Historie genutzt.</param>
///// <returns cref="DataObjects.UmsatzPrognoseAusgabe">Umsatzprognose inkl. Status-Objekt zur Nachvollziehbarkeit etwaig aufgetretener Fehler.</returns>
///// <exception cref="PythonParsingException"></exception>
//public DataObjects.UmsatzPrognoseAusgabe UmsatzprognoseDummy(int? firmaId, DateTime? analyseBeginn)
//{
// AssertNotDisposed();
// string pyJson;
// using (Py.GIL())
// {
// pyJson = pyModPipeline.pipeline_sales_forecast_dummy(firmaId, analyseBeginn);
// }
// var parsed = JsonSerializer.Deserialize<DataObjects.UmsatzPrognoseAusgabe>(pyJson) ?? throw new PythonParsingException("Could not correctly parse object from Python");
// return parsed;
//}
///// <summary>
///// Ausführung der Umsatzprognose-Pipeline mit Live-Daten.
///// Es werden API-Abrufe durchgeführt und somit auch Live-Daten genutzt.
///// Hierfür muss sichergestellt sein, dass der API-Server erreichbar und abrufbereit ist.
///// </summary>
///// <param name="firmaIds">optional: Liste von Firmen-IDs, für die die Pipeline ausgeführt werden soll.
///// Wird der Parameter nicht zur Verfügung gestellt, werden alle Firmen bzw. Kunden abgerufen</param>
///// <param name="analyseBeginn">optional: Start-Datum, ab dem die Daten für die Erstellung des Prognosemodells genutzt werden.
///// Daten, die weiter in der Vergangenheit liegen, werden nicht berücksichtigt.
///// Wird der Parameter nicht zur Verfügung gestellt, wird die gesamte Historie genutzt.</param>
///// <returns cref="DataObjects.UmsatzPrognoseAusgabe">Umsatzprognose inkl. Status-Objekt zur Nachvollziehbarkeit etwaig aufgetretener Fehler.</returns>
///// <exception cref="PythonParsingException"></exception>
//public DataObjects.UmsatzPrognoseAusgabe Umsatzprognose(List<int>? firmaIds, DateTime? analyseBeginn)
//{
// AssertNotDisposed();
// string pyJson;
// using (Py.GIL())
// {
// pyJson = pyModPipeline.pipeline_sales_forecast(firmaIds, analyseBeginn);
// }
// var parsed = JsonSerializer.Deserialize<DataObjects.UmsatzPrognoseAusgabe>(pyJson) ?? throw new PythonParsingException("Could not correctly parse object from Python");
// return parsed;
//}
///// <summary>
///// Setup der Python-internen Umgebung
///// </summary>
///// <param name="datenPfad">Pfad zu einem Ordner, in dem Programmdaten ohne Bedenken dauerhaft abgelegt werden können.</param>
///// <param name="basisApiUrl">Basis-URL zum Zugriff auf die API. Dies muss eine vollständige URL sein inkl. der Route "/api".</param>
//protected void Setup(string datenPfad, string basisApiUrl)
//{
// AssertNotDisposed();
// using (Py.GIL())
// {
// pyModManagement.setup(datenPfad, basisApiUrl);
// }
//}
///// <summary>
///// Hole die konfigurierte API-Basis-URL aus der Python-Umgebung
///// </summary>
///// <returns>konfigurierte Basis-URL</returns>
//protected string GetBaseApiUrl()
//{
// AssertNotDisposed();
// string pyJson;
// using (Py.GIL())
// {
// pyJson = (string)pyModManagement.get_base_url();
// }
// return pyJson;
//}
///// <summary>
///// Hole den konfigurierten Datenpfad zur Dateiverwaltung aus der Python-Umgebung
///// </summary>
///// <returns>konfigurierten Datenpfad</returns>
//protected string GetDataPath()
//{
// AssertNotDisposed();
// string pyJson;
// using (Py.GIL())
// {
// pyJson = (string)pyModManagement.get_data_path();
// }
// return pyJson;
//}
///// <summary>
///// Hole die konfigurierten Nutzerdaten zur API-Interaktion aus der Python-Umgebung
///// </summary>
///// <returns cref="DataObjects.Credentials">konfigurierte Nutzerdaten</returns>
///// <exception cref="PythonParsingException"></exception>
//protected DataObjects.Credentials GetCredentials()
//{
// AssertNotDisposed();
// string pyJson;
// using (Py.GIL())
// {
// pyJson = (string)pyModManagement.get_credentials();
// }
// DataObjects.Credentials? parsed = JsonSerializer.Deserialize<DataObjects.Credentials>(pyJson);
// return parsed ?? throw new PythonParsingException("Could not correctly parse object from Python");
//}
} }
} }

2
dopt.DeltaBarth/dopt.DeltaBarth.csproj
View File

@ -6,7 +6,7 @@
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<PlatformTarget>x64</PlatformTarget> <PlatformTarget>x64</PlatformTarget>
<Platforms>x64</Platforms> <Platforms>x64</Platforms>
<Version>0.4.0</Version> <Version>0.4.1-alpha1</Version>
<GenerateDocumentationFile>True</GenerateDocumentationFile> <GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup> </PropertyGroup>