agent/agent-framework
2
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

.NET: Enhance console samples while preserving copyability (#475)

Browse Source 
* Enhance console samples while preserving copyability

* Add readme for minimal console demo

* Suppress pre-release version warning

* Address PR comments

* Change showing settings to opt-in

* Update comment
This commit is contained in:
westey
2025-08-22 14:58:10 +00:00
committed by GitHub
parent 25291de8cb
commit 71a0bf22eb
9 changed files with 229 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dotnet/src/Shared/Demos/README.md
+20
View File
@@ -0,0 +1,20 @@
# Demos
Contains a helper that adds an override `System.Environment` class to a project.
This override version has an enhanced `GetEnvironmentVariable` method that prompts the user
to enter a value if the environment variable is not set.
The code is still fully copyable to another project. These sample projects just allow for a simplified user experience
for users who are new and just getting started.
To use this in your project, add the following to your `.csproj` file:
```xml
<ItemGroup>
<Using Include="SampleHelpers.SampleEnvironment" Alias="Environment" />
</ItemGroup>
<ItemGroup>
<Compile Include="$(MSBuildThisFileDirectory)\..\src\Shared\Demos\*.cs" LinkBase="" Visible="false" />
</ItemGroup>
```
dotnet/src/Shared/Demos/SampleEnvironment.cs
+142
View File
@@ -0,0 +1,142 @@
// Copyright (c) Microsoft. All rights reserved.
#pragma warning disable IDE0005 // Using directive is unnecessary. - need to suppress this, since this file is used in both projects with implicit usings and without.
using System;
using System.Collections;
using SystemEnvironment = System.Environment;
namespace SampleHelpers;
internal static class SampleEnvironment
{
public static string? GetEnvironmentVariable(string key)
{
// Allows for opting into showing all setting values in the console output, so that it is easy to troubleshoot sample setup issues.
var showAllSampleValues = SystemEnvironment.GetEnvironmentVariable("AF_SHOW_ALL_DEMO_SETTING_VALUES");
var shouldShowValue = showAllSampleValues?.ToUpperInvariant() == "Y";
var value = SystemEnvironment.GetEnvironmentVariable(key);
if (string.IsNullOrWhiteSpace(value))
{
var color = Console.ForegroundColor;
Console.ForegroundColor = ConsoleColor.Green;
Console.Write("Setting '");
Console.ForegroundColor = ConsoleColor.Yellow;
Console.Write(key);
Console.ForegroundColor = ConsoleColor.Green;
Console.WriteLine("' is not set in environment variables.");
Console.ForegroundColor = ConsoleColor.Green;
Console.Write("Please provide the setting for '");
Console.ForegroundColor = ConsoleColor.Yellow;
Console.Write(key);
Console.ForegroundColor = ConsoleColor.Green;
Console.Write("'> ");
Console.ForegroundColor = color;
value = Console.ReadLine();
value = string.IsNullOrWhiteSpace(value) ? null : value.Trim();
Console.WriteLine();
}
else if (shouldShowValue)
{
var color = Console.ForegroundColor;
Console.ForegroundColor = ConsoleColor.Green;
Console.Write("Using setting: Source=");
Console.ForegroundColor = ConsoleColor.Yellow;
Console.Write("EnvironmentVariables");
Console.ForegroundColor = ConsoleColor.Green;
Console.Write(", Key='");
Console.ForegroundColor = ConsoleColor.Yellow;
Console.Write(key);
Console.ForegroundColor = ConsoleColor.Green;
Console.Write("', Value='");
Console.ForegroundColor = ConsoleColor.Yellow;
Console.Write(value);
Console.ForegroundColor = ConsoleColor.Green;
Console.WriteLine("'");
Console.ForegroundColor = color;
Console.WriteLine();
}
return value;
}
// Methods that directly call System.Environment
public static string? GetEnvironmentVariable(string variable, EnvironmentVariableTarget target)
=> System.Environment.GetEnvironmentVariable(variable, target);
public static IDictionary GetEnvironmentVariables()
=> System.Environment.GetEnvironmentVariables();
public static IDictionary GetEnvironmentVariables(EnvironmentVariableTarget target)
=> System.Environment.GetEnvironmentVariables(target);
public static void SetEnvironmentVariable(string variable, string? value)
=> System.Environment.SetEnvironmentVariable(variable, value);
public static void SetEnvironmentVariable(string variable, string? value, EnvironmentVariableTarget target)
=> System.Environment.SetEnvironmentVariable(variable, value, target);
public static string[] GetCommandLineArgs()
=> System.Environment.GetCommandLineArgs();
public static string CommandLine
=> System.Environment.CommandLine;
public static string CurrentDirectory
{
get => System.Environment.CurrentDirectory;
set => System.Environment.CurrentDirectory = value;
}
public static string ExpandEnvironmentVariables(string name)
=> System.Environment.ExpandEnvironmentVariables(name);
public static string GetFolderPath(System.Environment.SpecialFolder folder)
=> System.Environment.GetFolderPath(folder);
public static string GetFolderPath(System.Environment.SpecialFolder folder, System.Environment.SpecialFolderOption option)
=> System.Environment.GetFolderPath(folder, option);
public static int ProcessorCount
=> System.Environment.ProcessorCount;
public static bool Is64BitProcess
=> System.Environment.Is64BitProcess;
public static bool Is64BitOperatingSystem
=> System.Environment.Is64BitOperatingSystem;
public static string MachineName
=> System.Environment.MachineName;
public static string NewLine
=> System.Environment.NewLine;
public static OperatingSystem OSVersion
=> System.Environment.OSVersion;
public static string StackTrace
=> System.Environment.StackTrace;
public static int SystemPageSize
=> System.Environment.SystemPageSize;
public static bool HasShutdownStarted
=> System.Environment.HasShutdownStarted;
#if NET9_0_OR_GREATER
public static int ProcessId
=> System.Environment.ProcessId;
public static string? ProcessPath
=> System.Environment.ProcessPath;
public static bool IsPrivilegedProcess
=> System.Environment.IsPrivilegedProcess;
#endif
}