---
title: "Fields"
url: https://docs.zeroc.com/ice/3.8/slice/fields
language: python
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Fields

Programming language: Python. Other languages: [C++](https://docs.zeroc.com/ice/3.8/slice/fields/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/slice/fields/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/slice/fields/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/slice/fields/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/slice/fields/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/slice/fields/php.md), [Ruby](https://docs.zeroc.com/ice/3.8/slice/fields/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/slice/fields/swift.md).

## Syntax

A field is defined as `Type name`, where `Type` is the field's type and `name` is the field's name. For example:

```slice
string name;
ByteSeq image;
Fruit fruit;
```

The type of a field can be a [basic type](https://docs.zeroc.com/ice/3.8/slice/basic-types/python.md), a [user-defined type](https://docs.zeroc.com/ice/3.8/slice/user-defined-types.md), `Object*` (an untyped proxy), or `Value` (an untyped class instance).

## Nullable and Non-Nullable Fields

Fields with proxy and class types are nullable: they can hold null. Fields of other types always hold a value, unless they are [optional fields](#optional-fields) that are not set.

```slice
struct Example
{
    int count; // must be set
    Greeter* greeter; // proxy type, so it can be null
    Node node; // class type, so it can be null
}
```

## Optional Fields

A field of a Slice [class](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/classes/python.md) or [exception](https://docs.zeroc.com/ice/3.8/slice/exceptions/python.md) may be declared as optional to indicate that a program can leave its value unset. Fields not declared as optional are known as *required* fields.

Each optional field must be assigned a unique, non-negative integer *tag*:

```slice
module M
{
    class C
    {
        string name;
        bool active;
        optional(2) string alternateName;
        optional(5) int overrideCode;
    }
}
```

The scope of a tag is the class or exception that defines the field, and this class or exception only: a derived class or exception can reuse a tag of its base type. For example:

```slice
exception BaseException
{
    optional(1) int systemCode;
}

exception DerivedException extends BaseException
{
    optional(1) string diagnostic; // OK: a different scope
}
```

Optional and required fields can be interleaved, and their tags can be in any order. The tag identifies the field in the [encoding](https://docs.zeroc.com/ice/3.8/encoding/data-encoding-for-optional-values.md); the language mappings do not expose it.

An optional field cannot have a class type, or a constructed type that holds a class type.

## Default Values

You can specify a default value for a field that has one of the following types:

- An [integral](https://docs.zeroc.com/ice/3.8/slice/basic-types/python.md) type (`byte`, `short`, `int`, `long`)
- A [floating point](https://docs.zeroc.com/ice/3.8/slice/basic-types/python.md) type (`float` or `double`)
- [string](https://docs.zeroc.com/ice/3.8/slice/basic-types/python.md)
- [bool](https://docs.zeroc.com/ice/3.8/slice/basic-types/python.md)
- [enum](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/python.md)

For example:

```slice
struct Location
{
    string name;
    Point pt;
    bool display = true;
    string source = "GPS";
}
```

The legal syntax for literal values is the same as for Slice [constants](https://docs.zeroc.com/ice/3.8/slice/constants-and-literals/python.md), and you may also use a constant as a default value. The language mapping guarantees that fields are initialized to their declared default values using a language-specific mechanism.

You can declare a default value for optional fields just as you can for required fields:

```slice
class C
{
    string name;
    bool active = true;
    optional(2) string alternateName;
    optional(5) int overrideCode = -1;
}
```

An optional field with a default value is considered to be set by default.

## Language Mapping

A Slice field maps to a Python dataclass field with the same name. The type of the Python field is the mapped Slice type.

For example:

```slice
class Address { ... }

struct Person
{
    string name;
    Address address;
}
```

maps to:

```py
@dataclass
class Person:
    name: str = ""
    address: Address | None = None
```

### Optional Fields {#language-mapping-optional-fields}

An optional field maps to a Python field with the same name. The mapped field’s type is the mapped type or `None`.

For example:

```slice
class C
{
    optional(2) string alternateName;
    optional(5) int overrideCode;
    optional(1) Widget* favoriteWidgetProxy;
}
```

maps to:

```py
@dataclass(eq=False)
class C(Value):
    alternateName: str | None = None
    overrideCode: int | None = None
    favoriteWidgetProxy: WidgetPrx | None = None
```

Optional and non-optional proxies are mapped the same way, as illustrated above. As a result, you cannot distinguish between an optional proxy field that is not set and an optional proxy field set to null (None).

### Default Values {#language-mapping-default-values}

Slice default values map to default values in Python.

For example:

```slice
struct Location
{
    string name;
    Point point;
    bool display = true;
    string source = "GPS";
}
```

maps to:

```py
@dataclass(order=True, unsafe_hash=True)
class Location:
    name: str = ""
    point: Point = field(default_factory=Point)
    display: bool = True
    source: str = "GPS"
```

When you don’t define a default value in Slice, and you initialize a field without providing a value for this field, the generated code uses the following default:

| **Optional Field?** | **Slice Field Type** | **Default Python Value** |
| --- | --- | --- |
| No | `string` | Empty string |
|  | `enum` | First enumerator in enumeration |
|  | `struct` | New instance created with no argument |
|  | `byte`, `short`, `int`, `long` | `0` |
|  | `float`, `double` | `0.0` |
|  | `bool` | `False` |
|  | `sequence<byte>` | Empty `bytes` |
|  | Other `sequence` | Empty list |
|  | `dictionary` | Empty dictionary |
|  | `class`, proxy | `None` |
| Yes | Any | `None` |

A sequence field whose type or declaration carries a [sequence metadata directive](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/sequences/python.md#customizing-the-sequence-mapping) defaults to an empty instance of the type the directive selects, such as an empty tuple for `python:tuple`. With `python:memoryview`, the default value is the object the factory function returns for a `None` buffer.
