optional notes что это

Optional note: перевод, синонимы, произношение, примеры предложений, антонимы, транскрипция

Произношение и транскрипция

Перевод по словам

adjective: необязательный, факультативный

noun: внимание, примечание, записка, нота, банкнот, замечание, заметка, запись, нотка, звук

verb: отмечать, делать заметки, записывать, указывать, обращать внимание, замечать, обозначать, составлять комментарии, аннотировать, упоминать

Предложения с «optional note»

Copyright © 2009-2021. All Rights Reserved.

Источник

Использование std::optional в С++17

Давайте возьмём пару от двух типов — что вы можете сделать с композицией подобного рода?

В этой статье я расскажу вам про std::optional — новый вспомогательный тип, добавленный в C++17. Это обёртка для вашего типа и флаг показывает, инициализировано ваше значение или нет. Давайте посмотрим, где это может быть полезно.

Вступление

Добавлением логических флагов к другим типам вы можете достичь то, что называется «Nullable типы». Как было сказано ранее, флаг используется для обозначения того, доступно значение или нет. Такая обёртка выразительно представляет объект, который может быть пустым (не через комментарии :).

Вы можете достигнуть пустого значения объекта с помощью использования уникальных идентификаторов (-1, бесконечность, nullptr ), но это не так точно выражает мысль, как отдельный тип-обёртка. Вы даже можете использовать std::unique_ptr и трактовать пустой указатель как неинициализированный объект — это сработает, но вместе с этим вы должны будете смириться с затратами на выделения памяти для объекта там, где в этом нет необходимости.

Этот тип является типом-значением (value-type) (таким образом, вы можете копировать его). Более того, для std::optional не нужно отдельно выделять память.

Использование

Обычно, опциональный тип может быть использован в следующих сценариях:

Хотя иногда тяжело решить, стоит ли использовать опциональный тип, вы точно не должны его использовать для обработки ошибок. Он лучше всего подходит для тех случаев, когда отсутствие значения является нормальным поведением программы.

Простой пример

Ниже вы можете увидеть простой пример того, что можно сделать с использованием опционального типа:

Серия

Эта статья является частью моей серии про библиотечные утилиты C++17. Вот список других тем, про которые я рассказываю:

Ресурсы по C++17 STL:

Создание std::optional

Есть несколько вариантов создания std::optional :

Как вы можете видеть в примере выше, вам доступна удивительная гибкость создания объекта. Создание объекта очень простое как для примитивных типов, так и для более сложных.

Например, вы можете написать:

Я расскажу про std::in_place позже, не переключайте канал и оставайтесь с нами.

Возврат std::optional из функции

Конечно, вы также можете просто объявить пустой опциональный объект в начале вышей функции и присвоить ему посчитанное значение, если оно корректно. Таким образом, мы можем переписать код выше следующим образом:

Какая версия лучше, зависит от контекста. Я предпочитаю короткие функции, поэтому мой выбор — версия №1 (с несколькими return ).

Получение значения

Возможно, самая важная операция для опционального типа (помимо его создания) — это то, как вы можете получить сохранённое значение.

Для этого есть несколько вариантов:

Таким образом, наиболее удобно, возможно, будет проверить, есть ли реальное значение в опциональном объекте, и затем использовать его:

Возможности std::optional

Давайте посмотрим, какие ещё есть возможности у опционального типа:

Изменение значения

Вот небольшой пример:

Этот код доступен здесь: @Coliru.

Сравнения

При выполнении кода выше, будет выведено:

Этот код доступен здесь: @Coliru.

Примеры с std::optional

Ниже вы найдёте два примера, где std::optional подходит идеально.

Имя пользователя с необязательным никнеймом и возрастом

Этот код доступен здесь: @Coliru.

Парсинг целых чисел из командной строки

Этот код доступен здесь: @Coliru.

Код выше использует опциональный тип данных для того, чтобы показать, успешно ли выполнено преобразование. Обратите внимание, что на самом деле мы обернули исключения, которые могут быть выброшены C++, в опциональный тип данных, поэтому мы пропустим все ошибки, связанные с этим. Этот момент достаточно спорный, так как обычно мы должны сообщать пользователю об ошибках.

Другие примеры

Производительность и анализ использования памяти

Если подходить абстрактно, то ваша версия STL может реализовывать опциональный тип данных как:

В кратце, std::optional просто оборачивает ваш тип, подготавливает место для него и добавляет один логический параметр. Это означает, что он увеличит размер вашего типа в соответствии с правилами выравнивания.

Есть один коментарий для этой конструкции: «Ни одна стандартная библиотека не сможет реализовать std::optional так (она должна использовать union из-за constexpr )». Поэтому код выше просто демонстрирует пример, а не реальную реализацию.

Правила выравнивания важны, как говорит стандарт:

Например, если у вас есть такой тип:

То он займёт больше места, чем если бы вы использовали свой тип вместо std::optional :

В первом случае размер структуры равен 32 байтам! Во втором случае всего лишь 24.

По ссылке великолепное объяснение насчёт производительности и использованию памяти, взятое из документации boost: вопросы производительности.

И в статье «Эффективные опциональные значения» автор рассуждает, как написать обёртку для опционального типа, которая может быть немного быстрее.

Интересно, есть ли шанс использовать хоть какую-то магию компилятора и повторно использовать некоторое пространство, чтобы поместить этот дополнительный флаг «инициализации объекта” внутри опционального типа. Тогда бы никакого дополнительного пространства не было бы необходимо.

Особенный случай: std::optional и std::optional

В то время как вы можете использовать std::optional для любого типа, которого захотите, вам надо проявить особое внимание при использовании опционального типа с логическим типом и указателями.

std::optional ob — о чём это говорит? С этой конструкцией вы имеете логический тип с тремя состояниями. Поэтому, если он вам и правда нужен, возможно лучше использовать настоящий троичный тип — std::tribool boost::tribool (правка: Antervis).

Более того, использование такого типа может сбивать с толку, потому что ob преобразуется в bool если в нём внутри есть значение и *ob возвращает хранимое значение (если оно доступно).

Похожая ситуация может проявиться с указателями:

Указатель на int на самом деле является nullable типом, поэтому оборачивание в опциональный тип только усложнит его использование.

Фух! Да, это было очень много текста про опциональный тип, но это не всё.

Тем не менее, мы рассмотрели основное использование, создание и оперирование эти удобным типом. Я считаю, что у нас есть много случаев, когда опциональный тип подходит намного лучше, чем использование некоторых предопределённых значений для представления nullable типов.

Я бы хотел напомнить следующие вещи про опциональный тип:

Источник

Java Optional не такой уж очевидный

Optional не должен равняться null

Знайте API

Optional обладает огромным количеством фичей, правильное использование которых позволяет добиться более простого и понятного кода.

Идея проста: если имя отсутствует, вернуть значение по умолчанию. Можно сделать это лучше.

Давайте рассмотрим что-нибудь посложнее. Предположим, что мы хотим вернуть Optional от имени пользователя. Если имя входит в список разрешенных, контейнер будет хранить значение, иначе — нет. Вот многословный пример.

Optional.filter упрощает код.

Если что-то доступно из коробки, попробуйте использовать это, прежде чем пытаться сделать свое.

Отдавайте предпочтение контейнерам «на примитивах»

Не пренебрегайте ленивыми вычислениями

Optional.orElse — это удобной инструмент для получения значения по умолчанию. Но если его вычисление является дорогой операцией, это может повлечь за собой проблемы с быстродействием.

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

Optional.orElseGet принимает на вход лямбду, которая будет вычислена только в том случае, если метод был вызван на пустом контейнере.

Не оборачивайте коллекции в Optional

Хотя я и видел такое не часто, иногда это происходит.

Любая коллекция является контейнером сама по себе. Для того чтобы показать отсутствие элементов в ней, не требуется использовать дополнительные обертки.

Чрезмерное использование Optional усложняет работу с API.

Не передавайте Optional в качестве параметра

А сейчас мы начинаем обсуждать наиболее спорные моменты.

Во-вторых, applySettings обладает четырьмя потенциальными поведениями в зависимости от того, являются ли переданные Optional пустыми, или нет.

Optional главным образом предназначен для использования в качестве возвращаемого значения в тех случаях, когда нужно отразить состояние «нет результата» и где использование null может привести к ошибкам.

Optional буквально символизирует нечто, что может содержать значение, а может — нет. Передавать возможное отсутствие результата в качестве параметра звучит как плохая идея. Это значит, что API знает слишком много о контексте выполнения и принимает те решения, о которых не должен быть в курсе.

Что же, как мы можем улучшить этот код? Если age и role должны всегда присутствовать, мы можем легко избавиться от Optional и решать проблему отсутствующих значений на верхнем уровне.

Теперь вызывающий код полностью контролирует значения аргументов. Это становится еще более критичным, если вы разрабатываете фреймворк или библиотеку.

С другой стороны, если значения age и role могут быть опущены, вышеописанный способ не заработает. В этом случае лучшим решением будет разделение API на отдельные методы, удовлетворяющим разным пользовательским потребностям.

Возможно это выглядит несколько многословно, но теперь пользователь может сам решить, какой метод вызвать, избегая непредвиденных ошибок.

Не используйте Optional в качестве полей класса

Я слышал разные мнения по этому вопросу. Некоторые считают, что хранение Optional напрямую в полях класса позволяет сократить NullPointerException на порядок. Мой друг, который работает в одном известном стартапе, говорит, что такой подход в их компании является утвержденным паттерном.

Хотя хранение Optional в полях класса и звучит как хорошая идея, я думаю, что это может принести больше проблем, чем пользы.

Отсутствие сериализуемости

На мой взгляд, этот аргумент является наименее убедительным, так как сейчас, в мире микросервисов и распределенных систем, платформенная сериализация не является настолько важной, как раньше.

Хранение лишних ссылок

Optional — это объект, который необходим пользователю всего несколько миллисекунд, после чего он может быть безболезненно удален сборщиком мусора. Но если мы храним Optional в качестве поля, он может оставаться там вплоть до самой остановки программы. Скорее всего, вы не заметите никаких проблем с производительностью на маленьких приложениях. Однако, если речь идет о большом сервисе с дюжинами бинов, последствия могут быть другие.

Плохая интеграция со Spring Data/Hibernate

Предположим, что мы хотим построить простое Spring Boot приложение. Нам нужно получить данные из таблицы в БД. Сделать это очень просто, объявив Hibernate сущность и соответствующий репозиторий.

Теперь все сломано.

Hibernate не может замапить значения из БД на Optional напрямую (по крайней мере, без кастомных конвертеров).

Но некоторые вещи работают правильно

Должен признать, что в конечном итоге не все так плохо. Некоторые фреймворки корректно интегрируют Optional в свою экосистему.

Jackson

Давайте объявим простой эндпойнт и DTO.

Как ни странно, все по-прежнему работает так, как и ожидается.

Это значит, что мы можем использовать Optional в качестве полей DTO и безопасно интегрироваться со Spring Web? Ну, вроде того. Однако есть потенциальные проблемы.

SpringDoc

SpringDoc — это библиотека для Spring Boot приложений, которая позволяет автоматически сгенерировать Open Api спецификацию.

Вот пример того, что мы получим для эндпойнта GET /person/ .

Это приведет к интересным результатам.

В чем здесь проблема? Например, если кто-то на фронтенде использует генератор типов сущностей по схеме Open Api, это приведет к получению неверной структуры, что в свою очередь может привести к повреждению данных.

Решение

Что же нам делать со всем этим? Ответ прост. Используйте Optional только для геттеров.

Однако у этого подхода есть один недостаток. Его нельзя полностью интегрировать с Lombok. Optional getters не подерживаются библиотекой и, судя по некоторым обсуждениям на Github, не будут.

На текущий момент единственным выходом является ручное объявление необходимых геттеров.

Источник

15 лайфхаков Notion — для работы, бизнеса и повседневных задач

Что такое Notion и для чего он нужен?

Notion содержит в себе заметки, таск-менеджер, органайзер и творческую мастерскую. Он особенно удобен, если вам приходится работать с разными форматами файлов и документов — их можно объединить в один проект. Внутри есть рабочее пространство, где можно создавать страницы с вложениями, боковая панель (сайдбар) с деревом страниц, основное поле для создания и редактирования блоков.

Что можно делать с помощью Notion

Главная особенность сервиса — в том, что он состоит из отдельных модулей, которые нужно собирать и настраивать под себя. На это уйдет какое-то время, но зато в результате вы получите универсальный рабочий инструмент вместо CRM или десятка приложений и онлайн-сервисов.

Кому подойдет Notion?

Плюсы и минусы Notion

💡 Плюсы:

💣 Минусы:

Лайфхаки для легкой и быстрой работы в Notion

💌 Импорт файлов

На панели слева (сайдбар) нажмите Import, затем в выпадающем окне выберите приложение, из которого хотите импортировать файлы. Если это Evernote, Google Docs, Trello или Asana, нужно сначала войти в аккаунт и подтвердить доступ для Notion.

📅 Добавьте дату

Подойдет тем, кто работает с документами, которые проходят множество правок. Откройте блок, в самом низу введите «/date», нажмите ввод и введите нужную дату. Это позволяет отслеживать все версии блоков и документов, переходя к нужной — удобнее, чем история версий в Google Docs.

🖥️ Используйте блоки с кодом

Подойдет разработчикам и тем, кто работает с ними в команде. Введите «/code» в конце блока, и в открывшемся окне добавьте программный код.

🌈 Помечайте блоки разными цветами

Эта функция — аналог цветовых меток в Trello. Она помогает сортировать задачи по этапам и исполнителям. Введите «/color» в конце блока и выберите нужный цвет. Можно выделять цветом сам текст или фон, чтобы пометить фрагменты документа.

👀 Вставляйте ссылки на посты в соцсетях, фото и видео

Эта функция позволит добавить текст, фото или видео прямо в блок, чтобы не нужно было переходить по ссылкам. Наберите в конце блока «/Video», чтобы вставить видео из YouTube или Vimeo и «/tweet» для вставки поста из Twitter.

📁 Добавляйте файлы из Google Drive и Google Maps

Наберите внизу блока «/google» и выберите в выпадающем меню Google Drive или Google Maps. Так вы сможете прикрепить документы, файлы, маршруты или адрес точки на карте.

🔮 Выберите нужный вам цвет темы

Зайдите в настройки (Settings) в сайдбаре, выберите Appearance и тему — Light или Dark. Также можно использовать сочетание клавиш Command + Shift + L или D (macOS) и Ctrl + Shift + L или D (Windows) для переключения между светлой и темной темами.

🔔 Добавляйте напоминания

Это удобно, когда вы работаете со множеством задач и хотите отслеживать дедлайны. Введите внизу блока «/remind» и добавьте дату и время, чтобы получить напоминание.

🧑‍🤝‍🧑 Управляйте проектами и командой

В Notion вы можете использовать шаблон Roadmap, чтобы пользоваться теми же функциями, что и в Trello.

Приложение можно «объединить» с групповым чатом в Slack, чтобы вы могли обсуждать все изменения в проекте, обмениваясь данными и файлами из Notion. Для этого нажмите Updates в верхнем правом углу приложения и Connect Slack Channel в выпадающем меню.

✈️ Планируйте поездки и путешествия

В шаблоне Travel Plans (вкладка Templates в левом меню, снизу) удобно составлять планы поездок по датам и маршрутам (через интеграцию с Google Maps), прикладывать билеты и брони, вести учет расходов для всех участников путешествия.

🖌️ Планируйте проект в UI/UX-дизайне

Для дизайнеров в Notion есть поддержка популярных платформ и приложений. Например, в конец блока можно добавить интеграцию: «/Figma» или «/Invisinon» — для соответствующих сервисов. Так вы сможете добавлять в проект все детали, описания и макеты.

☠️ Заблокируйте страницу

Вы можете заблокировать блок или страницу проекта, чтобы отключить возможность редактирования. Для этого нажмите на «…» в верхнем правом углу и выберите Database lock.

📤 Экспортируйте файлы

Выгружайте файлы HTML, Markdown, PDF и CSV-таблицы. Для этого нажмите в правом верхнем меню «…», затем — Export, далее выберите нужный формат.

🌍 Откройте публичный доступ к странице

Нажмите Share в правом верхнем углу приложения, выберите Share to web и Allow duplicate as template. Теперь вы можете отправить ссылку на страницу, а любой из членов команды сможет скопировать ее, вместе с задачами и файлами.

💸 Экономьте на оплате

В Notion можно снизить плату по тарифу, если воспользоваться специальными опциями. Зайдите в Settings → Earn Credits: здесь отображается сумма на вашем счете. Ее можно пополнить:

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

Источник

Введение в аннотации типов Python

Введение

Автор иллюстрации — Magdalena Tomczyk

Python — язык с динамической типизацией и позволяет нам довольно вольно оперировать переменными разных типов. Однако при написании кода мы так или иначе предполагаем переменные каких типов будут использоваться (это может быть вызвано ограничением алгоритма или бизнес логики). И для корректной работы программы нам важно как можно раньше найти ошибки, связанные с передачей данных неверного типа.

Сохраняя идею динамической утиной типизации в современных версиях Python (3.6+) поддерживает аннотации типов переменных, полей класса, аргументов и возвращаемых значений функций:

Аннотации типов просто считываются интерпретатором Python и никак более не обрабатываются, но доступны для использования из стороннего кода и в первую очередь рассчитаны для использования статическими анализаторами.

Меня зовут Тихонов Андрей и я занимаюсь backend-разработкой в Lamoda.

Инструменты, поддерживающие аннотации

Аннотации типов поддерживаются многими IDE для Python, которые выделяют некорректный код или выдают подсказки в процессе набора текста.

Например, так это выглядит в Pycharm:

Так же аннотации типов обрабатываются и консольными линтерами.

А вот для того же файла что нашел mypy:

Поведение разных анализаторов может отличаться. Например, mypy и pycharm по разному обрабатывают смену типа переменной. Далее в примерах я буду ориентироваться на вывод mypy.

В некоторых примерах код при запуске может работать без исключений, но может содержать логические ошибки из-за использования переменных не того типа. А в некоторых примерах он может даже не выполняться.

Основы

В отличие от старых версий Python, аннотации типов пишутся не в комментариях или docstring, а непосредственно в коде. С одной стороны, это ломает обратную совместимость, с другой — явно означает что это часть кода и может обрабатываться соответственно

В простейшем случае аннотация содержит непосредственно ожидаемый тип. Более сложные кейсы будут рассмотрены ниже. Если в качестве аннотации указан базовый класс, допустимо передача экземпляров его наследников в качестве значений. Однако использовать можно только те возможности, что реализованы в базовом классе.

Аннотации для переменных пишут через двоеточие после идентификатора. После этого может идти инициализация значения. Например,

Для полей класса аннотации должны быть указаны явно при определении класса. Однако анализаторы могут выводить автоматически их на основе __init__ метода, но в этом случае они не будут доступны во время выполнения программы. Подробнее про работу с аннотациями в рантайме во второй части статьи

Кстати, при использовании dataclass типы полей необходимо указывать именно в классе. Подробнее про dataclass

Встроенные типы

Optional

Incompatible types in assignment (expression has type «None», variable has type «int»)

Для таких случаев предусмотрена в модуле typing аннотация Optional с указанием конкретного типа. Обратите внимание, тип опциональной переменной указывается в квадратных скобках

Union

Для случаев, когда необходимо допустить использование не любых типов, а только некоторых, можно использовать аннотацию typing.Union с указанием списка типов в квадратных скобках.

Коллекции

Механизм аннотаций типов поддерживает механизм дженериков (Generics, подробнее во второй части статьи), которые позволяют специфицировать для контейнеров типы элементов, хранящихся в них.

Списки

Кортежи

Кортежи в отличие от списков часто используются для разнотипных элементов. Синтаксис похож с одним отличием: в квадратных скобках указывается тип каждого элемента кортежа по отдельности.

Словари

Аналогично используются typing.DefaultDict и typing.OrderedDict

Результат выполнения функции

Для указания типа результата функции можно использовать любую аннотацию. Но есть несколько особенных случаев.

Если же функция никогда не возвращает управление (например, как sys.exit ), следует использовать аннотацию NoReturn :

Вместо заключения

Так же стандарт определяет формат аннотаций в виде комментариев и stub-файлы, которые содержат информацию только для статических анализаторов.

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

Источник