feat: Move navbar_options into single argument with helper navbar_options()
#1822
Conversation
gadenbuie
changed the title
navbar_options() into single argument with helpernavbar_options into single argument with helper navbar_options()
There was a problem hiding this comment.
@schloerke Can you review the changes in this file for me? I wanted an object that operates like MISSING but gives a better hint to users in the function signature, so I created a new sentinel DEPRECATED object. Look at page_navbar() or navset_bar() (in _navs.py, which might be hidden for being a large diff) to see how this is used.
|
|
||
| # Sentinel value - indicates a missing value in a function call. | ||
| class MISSING_TYPE: | ||
| pass | ||
|
|
||
|
|
||
| MISSING: MISSING_TYPE = MISSING_TYPE() | ||
| DEPRECATED: MISSING_TYPE = MISSING_TYPE() # A MISSING that communicates deprecation | ||
| MaybeMissing = Union[T, MISSING_TYPE] |
There was a problem hiding this comment.
I find bg: MaybeMissing[str | None] = MISSING a bit more readable than bg: str | None | MISSING_TYPE = MISSING, so this just provides a bit of sugar around the common pattern.
| def is_missing(x: Any) -> TypeIs[MISSING_TYPE]: | ||
| return x is MISSING or isinstance(x, MISSING_TYPE) |
There was a problem hiding this comment.
TIL about the difference between TypeGuard and TypeIs. (TypeGuard only narrows the type scope in the positive case [if it is, it is, otherwise it might still be], while TypeIs narrows the type on both sides [it either is or it isn't].)
Anyway, this could also just be isinstance(x, MISSING_TYPE) but it's a little more succinct when used.
Moves navbar options
position,bg,inverse,underlineandcollapsibeinto anavbar_optionsargument inui.page_navbar()andui.navset_bar(). These options can be prepared with a new helperui.navbar_options(). Further,inverseis replaced withthemeinui.navber_options().Reflects changes in
navbar_options()rstudio/bslib#1141The top-level direct arguments are now deprecated, but users can continue to use them (with a deprecation warning).